Mongodb MCP Server

🚀 📢 社區服務器通知

這是一個由社區維護的MCP服務器，提供對MongoDB數據庫的只讀訪問。若您想訪問官方MongoDB MCP服務器，請前往 mongodb-js/mongodb-mcp-server。

🚀 快速開始

本服務器是一個提供對MongoDB數據庫只讀訪問的模型上下文協議（MCP）服務器，它能讓LLM檢查集合模式並執行聚合管道。

✨ 主要特性

• 提供對MongoDB數據庫的只讀訪問。
• 使LLM能夠檢查集合模式並執行聚合管道。
• 具備多種工具和資源，方便對數據庫進行操作和獲取信息。
• 擁有安全功能，保障數據操作的安全性。

📦 安裝指南

要使用此服務器與Claude Desktop應用，需將以下配置添加到claude_desktop_config.json文件的“mcpServers”部分：

"mongodb": {
      "command": "npx",
      "args": [
        "-y" ,
        "@pash1986/mcp-server-mongodb"
      ],
     "env" : {
	"MONGODB_URI" : "mongodb+srv://<yourcluster>" // 'mongodb://localhost:27017'
	}
    }

請將mydb替換為您的數據庫名稱，並根據需要調整連接字符串。

💻 使用示例

基礎用法

基本聚合

{
  "collection": "users",
  "pipeline": [
    { "$match": { "age": { "$gt": 21 } } },
    { "$group": {
      "_id": "$city",
      "avgAge": { "$avg": "$age" },
      "count": { "$sum": 1 }
    }},
    { "$sort": { "count": -1 } },
    { "$limit": 10 }
  ],
  "options": {
    "allowDiskUse": true,
    "maxTimeMS": 60000,
    "comment": "City-wise user statistics"
  }
}

查詢解釋

{
  "collection": "users",
  "pipeline": [
    { "$match": { "age": { "$gt": 21 } } },
    { "$sort": { "age": 1 } }
  ],
  "verbosity": "executionStats"
}

📚 詳細文檔

組件

工具

• aggregate

  • 功能：對連接的數據庫執行MongoDB聚合管道。
  • 輸入：
    • collection (字符串)：要查詢的集合。
    • pipeline (數組)：MongoDB聚合管道階段。
    • options (對象)：可選的聚合設置。
      • allowDiskUse (布爾值)：允許使用磁盤操作。
      • maxTimeMS (數字)：最大執行時間，以毫秒為單位。
      • comment (字符串)：標識操作的註釋。
  • 限制：默認文檔限制為1000個，如果沒有指定限制階段；默認超時時間為30秒。

• explain

  • 功能：獲取聚合管道的執行計劃。
  • 輸入：
    • collection (字符串)：要分析的集合。
    • pipeline (數組)：MongoDB聚合管道階段。
    • verbosity (字符串)：解釋的詳細程度。
      • 選項："queryPlanner"、"executionStats"、"allPlansExecution"。
      • 默認："queryPlanner"。

資源

服務器為每個數據庫集合提供模式信息：

• 集合模式 (mongodb://<host>/<collection>/schema)
  • 集合的推導JSON模式信息。
  • 包括字段名稱和數據類型。
  • 模式是從樣本文檔中推導出來的。

🔧 技術細節

• 安全功能：
  • 如果管道中未指定限制，默認限制為1000個文檔。
  • 所有操作的默認超時時間為30秒。
  • 僅支持只讀操作。
  • 從集合樣本的安全模式推斷。

📄 許可證

此MCP服務器根據MIT許可證發佈。這意味著您可以自由使用、修改和分發軟件，但需遵循MIT許可證的條款和條件。有關詳細信息，請參閱項目存儲庫中的LICENSE文件。