使用说明

项目简介

Mongo MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，它充当大型语言模型 (LLM) 与 MongoDB 数据库之间的桥梁。通过此服务器，LLM 应用能够以自然语言的方式访问和操作 MongoDB 数据库，实现数据查询、模式探索、索引管理和文档操作等功能。

主要功能点

集合结构探索：允许 LLM 获取 MongoDB 集合的结构信息，了解数据模式。
文档查询与过滤：支持使用自然语言查询和过滤 MongoDB 文档，检索所需数据。
索引管理：提供创建、删除和列出集合索引的功能，优化数据查询性能。
文档增删改查：支持对 MongoDB 文档进行插入、更新和删除操作。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js 18 或更高版本 (https://nodejs.org/en/)。
安装 npx: 通常 Node.js 安装包自带 npx，无需额外安装。
配置 MCP 客户端: 您需要一个 MCP 客户端，例如 Claude Desktop 应用。

服务器配置

要将 Mongo MCP Server 集成到 MCP 客户端（例如 Claude Desktop），您需要在客户端的配置文件中添加服务器配置信息。以 Claude Desktop 为例，您需要编辑其配置文件 'claude_desktop_config.json'，该文件通常位于：

MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

在配置文件中，添加或修改 'mcpServers' 部分，加入以下配置：

{
  "mcpServers": {
    "mongodb": {  // 服务器名称，可以自定义
      "command": "npx",  // 启动服务器的命令，这里使用 npx 运行 mongo-mcp
      "args": [
        "mongo-mcp",  //  npx 运行的包名，对应 package.json 中的 "name": "mongo-mcp"
        "mongodb+srv://<username>:<password>@<cluster-address>/<database>" // MongoDB 连接字符串，请替换为您的实际连接信息
      ]
    }
  }
}

请务必将 '<username>:<password>@<cluster-address>/<database>' 替换为您的实际 MongoDB 连接字符串。

基本使用方法

配置完成后，启动您的 MCP 客户端（如 Claude Desktop）。客户端将自动连接到 Mongo MCP Server。您可以通过客户端提供的界面或指令，调用以下工具与 MongoDB 数据库进行交互：

查询工具:

'listCollections': 列出所有集合
'getCollectionSchema': 获取集合的 schema 信息
'findDocument': 查询文档
'insertDocument': 插入文档
'updateDocument': 更新文档

索引工具:

'createIndex': 创建索引
'deleteIndex': 删除索引
'listIndexes': 列出索引

具体工具的使用方法和参数，请参考 MCP 客户端的文档或界面提示。

关键词