项目简介

'MongoDB Atlas MCP Server' 是一个基于 Model Context Protocol (MCP) 实现的服务器,旨在为大型语言模型 (LLM) 客户端提供与 MongoDB Atlas 云数据库交互的能力。它允许LLM通过标准化的MCP协议,安全地访问和管理 MongoDB Atlas 中的项目和集群资源。

主要功能点

  • 身份认证 (Auth Tool): 通过设备授权流程 (Device Authorization Flow) 安全地认证到 MongoDB Atlas,为后续操作获取必要的访问令牌。
  • 集群列表 (List Clusters Tool): 列出用户在 MongoDB Atlas 中拥有的所有集群,或特定项目下的集群,并以表格形式呈现集群名称、状态、MongoDB 版本、区域和连接字符串等关键信息。
  • 项目列表 (List Projects Tool): 列出用户在 MongoDB Atlas 中拥有的所有项目,并以表格形式展示项目名称、项目ID和创建时间。

安装步骤

  1. 克隆仓库: 首先,将 'atlas-mcp-server' 仓库克隆到本地。
    git clone https://github.com/mongodb-labs/atlas-mcp-server.git
    cd atlas-mcp-server
  2. 安装依赖: 使用 'npm' 安装项目依赖。
    npm install
  3. 构建项目: 构建 TypeScript 代码,生成可执行的 JavaScript 文件。
    npm run build

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以下是配置 'atlas-mcp-server' 的 JSON 格式配置信息示例,你需要根据你的 MCP 客户端进行配置。

{
  "servers": {
    "atlas-mcp-server": {  //  服务器名称,可以自定义
      "type": "stdio",     //  传输协议类型,这里使用 Stdio
      "command": "/path/to/atlas-mcp-server/dist/index.js", //  MCP 服务器启动命令,需要替换为你的实际路径, 例如 /Users/yourname/atlas-mcp-server/dist/index.js
      "args": []          //  启动参数,本服务器无需额外参数
    }
  }
}

注意:

  • 请将 '"command"' 字段中的 '/path/to/atlas-mcp-server/dist/index.js' 替换为你本地 'atlas-mcp-server' 仓库 'dist/index.js' 文件的绝对路径
  • 不同的 MCP 客户端配置方式可能略有差异,请参考你使用的 MCP 客户端的文档进行配置。例如,对于 VSCode,可以参考仓库 README 中的 "VSCode" 部分进行配置。

基本使用方法

  1. 启动 MCP 服务器: 在克隆的 'atlas-mcp-server' 仓库目录下,无需手动启动服务器。MCP 客户端 (如 VSCode 或 Claude) 会在需要时根据配置的 'command' 自动启动服务器。

  2. 在 MCP 客户端中使用工具:

    • 身份认证: 在 MCP 客户端中,调用 'auth' 工具进行 MongoDB Atlas 身份认证。首次使用时,会提示你访问验证链接并输入用户代码以完成认证。认证成功后,会保存 Token,后续操作无需再次认证。
    • 列出集群: 调用 'list-clusters' 工具,可以列出所有 MongoDB Atlas 集群。你可以选择性地提供 'projectId' 参数来筛选特定项目下的集群。
    • 列出项目: 调用 'list-projects' 工具,可以列出所有 MongoDB Atlas 项目。

    具体工具调用方式取决于你使用的 MCP 客户端的界面和操作方式。通常,你可以在 LLM 客户端的聊天界面中,通过特定指令或菜单来选择和调用 MCP 服务器提供的工具。 例如,在支持工具箱的客户端中,你可能会看到 'atlas-mcp-server' 提供的工具列表,并可以直接选择使用。

例如,在支持工具箱的客户端中,你可以尝试以下步骤:

  1. 确保已正确配置并添加 'atlas-mcp-server' 到你的 MCP 客户端。
  2. 打开客户端的聊天界面,查看工具箱图标是否可见,并确认 'atlas-mcp-server' 已列出。
  3. 选择 'auth' 工具进行身份验证。按照提示完成认证流程。
  4. 认证成功后,选择 'list-clusters' 或 'list-projects' 工具,查看 MongoDB Atlas 集群或项目列表。

信息

分类

数据库与文件