🚀 MongoDB MCP 服务器

MongoDB MCP 服务器是一个基于模型上下文协议（Model Context Protocol）的服务器，它提供对 MongoDB 数据库的只读访问。借助该服务器，大型语言模型（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 License 发布。这意味着您可以自由使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。有关更多详细信息，请参见项目存储库中的 LICENSE 文件。