使用说明

项目简介

MongoDB MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，它允许大型语言模型 (LLM) 安全地访问和查询 MongoDB 数据库。通过此服务器，LLM 可以获取 MongoDB 集合的结构信息并执行复杂的聚合分析，从而实现更强大的数据驱动的 LLM 应用。

主要功能点

集合模式资源 (Collection Schemas): 以 JSON 格式提供 MongoDB 集合的结构信息，包括字段名和数据类型，帮助 LLM 理解数据结构。
聚合工具 (aggregate Tool): 允许 LLM 执行 MongoDB 聚合管道查询，进行复杂的数据分析和处理，返回聚合结果。
执行计划工具 (explain Tool): 提供聚合管道的执行计划，帮助开发者或高级用户分析和优化查询性能。
样本数据工具 (sample Tool): 返回集合中的随机文档样本，允许 LLM 快速预览数据内容和格式。
安全性: 只提供只读访问，并限制了查询时间和结果大小，确保数据库安全和稳定运行。

安装步骤

前提条件: 确保已安装 Node.js 和 npm (Node.js 包管理器)。

下载代码: 从 GitHub 仓库克隆代码到本地：

git clone https://github.com/MCP-Mirror/mongodb-developer_mongodb-mcp-server.git

进入目录: 使用命令行工具切换到项目目录：

cd mongodb-developer_mongodb-mcp-server

安装依赖: 安装项目所需的 npm 包：
```
npm install
```
配置环境变量: 设置 MongoDB 连接 URI。你需要设置 'MONGODB_URI' 环境变量来指定你的 MongoDB 数据库连接信息。
- 你可以直接在终端中设置环境变量（临时）：
```
export MONGODB_URI="你的MongoDB连接字符串"
```
- 或者，更推荐的做法是在项目根目录下创建一个 '.env' 文件，并在文件中添加：
```
MONGODB_URI="你的MongoDB连接字符串"
```
  请将 '"你的MongoDB连接字符串"' 替换为实际的 MongoDB 连接 URI，例如 'mongodb+srv://<用户名>:<密码>@<集群地址>/<数据库名>?retryWrites=true&w=majority' 或 'mongodb://localhost:27017/<数据库名>'。

服务器配置

以下 JSON 配置信息用于配置 MCP 客户端 (如 Claude Desktop) 连接到 MongoDB MCP Server。将此配置添加到你的 MCP 客户端的服务器配置文件中。

{
  "mongodb": {
    "command": "npx",
    "args": [
      "-y",
      "@pash1986/mcp-server-mongodb"
    ],
    "env": {
      "MONGODB_URI": "<your_mongodb_connection_string>" //  请替换为你的 MongoDB 连接字符串，例如：mongodb+srv://<用户名>:<密码>@<集群地址>/<数据库名>?retryWrites=true&w=majority。请确保在运行服务器的环境中设置了此环境变量。
    }
  }
}

基本使用方法

启动服务器: 在项目根目录下，使用以下命令启动 MongoDB MCP Server：
```
npm start
```
或者
```
node index.js
```
服务器成功启动后，它将监听 MCP 客户端的请求。
客户端交互: 在 MCP 客户端 (如 Claude Desktop) 中配置并连接到 MongoDB MCP Server。客户端可以通过 MCP 协议发送请求，例如：
- 请求资源列表以获取可用的集合模式资源。
- 读取集合模式资源以获取特定集合的结构信息。
- 调用 'aggregate' 工具执行 MongoDB 聚合查询。
- 调用 'explain' 工具获取查询执行计划。
- 调用 'sample' 工具获取集合样本数据。
客户端将接收来自 MongoDB MCP Server 的 JSON-RPC 响应，其中包含请求的数据或工具执行结果。

关键词