MongoDB MCP Server 使用说明

项目简介

MongoDB MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接大型语言模型 (LLM) 与 MongoDB 数据库。它允许 LLM 通过自然语言指令查询 MongoDB 数据、检查数据库结构、管理索引以及执行文档操作，为构建数据驱动的 LLM 应用提供强大的后端支持。

主要功能点

数据库交互： 允许 LLM 查询 MongoDB 数据库中的文档，支持复杂的过滤和投影操作。
Schema 探索： 能够让 LLM 了解 MongoDB 数据库的集合结构和字段类型。
索引管理： 支持 LLM 创建、删除和列出 MongoDB 集合的索引，优化查询性能。
数据操作： 允许 LLM 执行文档的插入、更新和删除操作，实现数据的增删改。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js (版本 18+) 和 npm (Node.js 包管理器)。

克隆仓库: 使用 Git 克隆 MongoDB MCP Server 仓库到本地：

git clone https://github.com/QuantGeekDev/mongo-mcp.git
cd mongo-mcp

安装依赖: 在仓库目录下，使用 npm 安装项目依赖：
```
npm install
```
构建项目: 运行构建脚本编译 TypeScript 代码：
```
npm run build
```

服务器配置

要将 MongoDB MCP Server 集成到 MCP 客户端（例如 Claude Desktop），你需要配置客户端以启动并连接到该服务器。以下是 Claude Desktop 客户端的 'claude_desktop_config.json' 配置文件示例，展示了如何配置 MongoDB MCP Server：

{
  "mcpServers": {
    "mongodb": {
      "command": "node",
      "args": [
        "dist/index.js",
        "mongodb://<your_mongodb_connection_url>"
      ]
    }
  }
}

配置参数说明:

'"mongodb"': 服务器名称，可以自定义，用于在客户端中标识和选择该服务器。
'"command": "node"': 启动服务器的命令，这里使用 'node' 命令来执行 JavaScript 文件。
'"args"': 传递给启动命令的参数数组。
- '"dist/index.js"': 指定服务器入口文件路径。
- '"mongodb://<your_mongodb_connection_url>"': [重要] MongoDB 数据库的连接 URL。请务必替换 '<your_mongodb_connection_url>' 为你实际的 MongoDB 连接字符串, 例如 'mongodb://root:example@localhost:27017/test?authSource=admin'。

注意: 你需要根据你的 MongoDB 数据库的实际连接信息，修改连接 URL。

基本使用方法

启动 MCP 服务器: 配置 Claude Desktop 或其他 MCP 客户端后，启动客户端应用。客户端会自动根据配置启动 MongoDB MCP Server。
在 LLM 客户端中使用: 在 LLM 客户端的对话界面中，你可以使用自然语言指令来指示 LLM 与 MongoDB 数据库进行交互。例如，你可以尝试以下提示：
- '"数据库里有哪些集合?"' (对应 'listCollections' 工具)
- '"users 集合的结构是什么样的?"' (需要实现 schema 探索工具，仓库中未直接提供，但有 schema 推断代码，可能需要自行扩展工具)
- '"查找所有在旧金山的用户"' (对应 'find' 工具)
- '"创建 products 集合 category 字段的索引"' (对应 'createIndex' 工具)
具体的指令取决于你在提示词中如何引导 LLM 使用可用的工具。你可以参考仓库 'README.md' 中 Example Prompts 部分的示例，了解更多使用方法。

本地测试 Sandbox (可选):

如果你没有可用的 MongoDB 服务器，可以使用仓库提供的 Docker Compose 快速启动一个测试环境：

确保已安装 Docker 和 Docker Compose。
在仓库根目录下运行： 'docker-compose up -d'
初始化测试数据： 'npm run seed'

然后使用本地开发模式配置连接到 Sandbox MongoDB 数据库。

{
  "mcpServers": {
    "mongodb": {
      "command": "node",
      "args": [
        "dist/index.js",
        "mongodb://root:example@localhost:27017/test?authSource=admin"
      ]
    }
  }
}

关键词