Manpreet2000 MCP Database Server

🚀 MCP 數據庫服務器

MCP 數據庫服務器是一個基於 Model Context Protocol (MCP) 的服務器實現，它讓大型語言模型（LLMs）能夠通過自然語言與多種數據庫進行交互。目前已支持 MongoDB，未來還會支持更多數據庫。

🚀 快速開始

MCP 數據庫服務器允許大型語言模型通過自然語言與數據庫交互，當前支持 MongoDB，後續將拓展更多數據庫類型。

✨ 主要特性

• 自然語言交互：可通過自然語言執行數據庫操作。
• MongoDB 功能豐富：支持列出所有集合、帶過濾和投影的文檔查詢、插入文檔、刪除文檔以及聚合管道操作。
• 未來拓展性強：計劃支持 PostgreSQL（執行 SQL 查詢和表操作）、CockroachDB（分佈式 SQL 操作）和 Redis（鍵值對操作和緩存）。

📦 安裝指南

先決條件

• Node.js v20.12.2 或更高版本。
• 數據庫（當前為 MongoDB，其他數據庫即將推出）。
• Claude Desktop 應用程序。

安裝步驟

1. 克隆倉庫：

git clone https://github.com/manpreet2000/mcp-database-server.git
cd mcp-database-server

2. 安裝依賴項：

npm install

3. 構建 TypeScript 代碼：

npm run build

🔧 配置

要在開始之前，您需要在 Claude Desktop 配置文件中設置數據庫連接：

MacOS

~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows

%APPDATA%/Claude/claude_desktop_config.json

將以下配置添加到您的 claude_desktop_config.json 文件中：

{
  "mcpServers": {
    "database": {
      "command": "/path/to/node",
      "args": ["/path/to/mcp-database/dist/index.js"],
      "env": {
        "MONGODB_URI": "your-mongodb-connection-string"
      }
    }
  }
}

替換以下內容：

• /path/to/node：替換為您系統的 Node.js 可執行文件路徑，或僅使用 node。
• /path/to/mcp-database：替換為此倉庫的絕對路徑。
• your-mongodb-connection-string：替換為您的 MongoDB 連接字符串。

💻 使用示例

基礎用法

MongoDB 示例

1. 列出數據庫中的所有集合：

你能給我看看我數據庫裡的所有集合嗎？

2. 獲取特定集合中的記錄：

請給我看一下chargers集合的2條記錄

3. 帶過濾條件的查詢：

在users集合中顯示狀態為active的所有文檔

4. 插入一個文檔：

在users集合中添加一個新的用戶，名字是John，郵箱是john@example.com

5. 刪除一個文檔：

從users集合中刪除郵箱為john@example.com的用戶

6. 聚合操作：

給我看一下users集合中按狀態分類的用戶總數

📚 詳細文檔

可用工具

1. getCollections

列出數據庫中的所有集合。

2. getCollection

獲取指定名稱的集合。

• 參數：
  • collectionName：需要獲取的集合名稱。

3. find

執行查詢操作，返回指定數量的結果。

• 參數：
  • collectionName：要查詢的集合名稱。
  • query（可選）：查詢條件。
  • limit（可選）：限制返回結果的數量，默認為 5。

4. findOne

執行單個文檔查詢。

• 參數：
  • collectionName：要查詢的集合名稱。
  • query：查詢條件。

5. insertOne

插入一個新文檔。

• 參數：
  • collectionName：文檔要插入到哪個集合。
  • document：要插入的文檔內容。

6. deleteOne

刪除指定查詢匹配的第一個文檔。

• 參數：
  • collectionName：要刪除文檔所在的集合。
  • query：刪除條件。

7. updateOne

更新指定查詢匹配的第一個文檔，設置新的值。

• 參數：
  • collectionName：文檔要更新的集合。
  • query：更新條件。
  • update：新的值。

🔮 未來支持

未來將支持以下數據庫：

• PostgreSQL：通過自然語言執行復雜的 SQL 查詢和表操作。
• CockroachDB：在分佈式環境中執行高效的 SQL 操作。
• Redis：利用鍵值對存儲和緩存功能，實現快速數據訪問。

⚠️ 安全注意事項

⚠️ 重要提示

要確保 MongoDB 連接字符串不被洩露，建議使用環境變量來管理敏感信息。

💡 使用建議

在生產環境中啟用身份驗證機制，保護數據庫免受未授權訪問。

🤝 貢獻指南

如果您發現任何問題或有改進建議，請考慮提交一個 GitHub 問題或拉取請求（Pull Request）。您的貢獻將幫助我們不斷改進 MCP 數據庫服務器的功能和性能。