使用说明

项目简介

MongoDB Lens MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在通过自然语言与 MongoDB 数据库进行交互。它提供了一系列资源和工具,使用户能够以更直观、便捷的方式探索、查询、管理和分析 MongoDB 数据。

主要功能点

  • 数据库与集合探索:列出数据库、集合,查看集合结构(Schema)、统计信息和索引信息。
  • 数据查询与操作:使用自然语言查询文档、进行聚合分析、执行数据插入、更新和删除操作。
  • 性能分析:分析查询性能、获取数据库和集合的统计信息,优化数据库操作。
  • 安全管理:管理数据库用户,进行安全审计。
  • 智能助手:内置 Prompt 模板,例如查询构建器、Schema 分析、数据建模助手和 SQL 到 MongoDB 的转换工具,辅助完成复杂任务。

安装步骤

  1. 前提条件:确保已安装 Node.js 和 npm。
  2. 下载代码:从 GitHub 克隆 'mcp-servers' 仓库:
    git clone https://github.com/AnyContext-ai/mcp-servers
  3. 进入目录:导航到 'mongodb-lens' 目录:
    cd mcp-servers/src/mongodb-lens
  4. 安装依赖:安装项目依赖:
    npm install

服务器配置

为了让 MCP 客户端连接到 MongoDB Lens MCP Server,您需要在客户端中配置服务器启动信息。以下是一个典型的 JSON 格式配置示例:

{
  "server name": "MongoDB Lens",
  "command": "node",
  "args": [
    "mongodb-lens.js",
    "--mongodb_uri", "mongodb://localhost:27017"  // MongoDB 连接 URI,请替换为您的 MongoDB 连接信息,或者设置 MONGO_URI 环境变量
  ]
}

配置参数说明:

  • 'server name': MCP 客户端中显示的服务名称,您可以自定义。
  • 'command': 启动服务器的命令,这里使用 'node' 执行 JavaScript 文件。
  • 'args': 传递给 'command' 的参数数组:
    • '"mongodb-lens.js"': MongoDB Lens 服务器的主程序文件。
    • '--mongodb_uri': 可选参数,用于直接指定 MongoDB 连接 URI。如果您不在此处指定,可以通过设置 'MONGO_URI' 环境变量来配置。请将 '"mongodb://localhost:27017"' 替换为您实际的 MongoDB 连接字符串(例如 '"mongodb://user:password@host:port/database"')。

基本使用方法

  1. 启动服务器:在 'mongodb-lens' 目录下,确保 MongoDB 服务已运行,然后在命令行执行配置中指定的启动命令。
  2. 配置 MCP 客户端:在 MCP 客户端中,添加上述服务器配置信息。客户端将使用这些信息连接到 MongoDB Lens MCP Server。
  3. 使用 MCP 客户端:连接成功后,您可以在 MCP 客户端中使用自然语言指令,通过 MongoDB Lens MCP Server 提供的资源、工具和 Prompt 模板与 MongoDB 数据库进行交互。例如,您可以:
    • 使用 'list-databases' 工具列出所有数据库。
    • 使用 'find-documents' 工具查询指定集合中的文档。
    • 使用 'query-builder' Prompt 模板构建复杂的 MongoDB 查询。

注意:请确保 MongoDB 服务可访问,并根据您的 MongoDB 实例配置正确的连接 URI。

信息

分类

数据库与文件