使用说明
项目简介
MongoDB Atlas MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,旨在通过标准化的方式,让LLM客户端能够便捷地管理MongoDB Atlas云服务。它提供了一系列工具,允许用户通过自然语言指令,在LLM客户端中直接创建、配置和管理MongoDB Atlas的各种资源,例如集群、用户和网络访问等。
主要功能点
- 集群管理: 创建新的MongoDB Atlas集群。
- 网络访问配置: 配置MongoDB Atlas项目的网络访问权限。
- 用户管理: 创建和管理MongoDB Atlas数据库用户。
- 连接信息获取: 获取MongoDB Atlas集群的连接字符串。
- 项目与集群列表: 列出MongoDB Atlas项目和集群信息。
安装步骤
- 安装Node.js和npm: 确保你的开发环境中已安装Node.js和npm。
- 安装MCP服务器: 在命令行终端中执行以下命令安装 'mcp-mongodb-atlas' 包:
npm install mcp-mongodb-atlas
服务器配置
要将此MCP服务器与MCP客户端(如Cline, Cursor, Claude Desktop等)连接,您需要在客户端的MCP设置中添加服务器配置。以下是通用的配置信息,您需要根据您的MCP客户端进行适配。
通用配置 (JSON 格式):
{ "serverName": "atlas", // 服务器名称,可以自定义,例如 "atlas-manager" "command": "npx", // 运行命令,通常为 npx 或 node "args": ["mcp-mongodb-atlas"], // 启动服务器的参数,这里是 mcp-mongodb-atlas 包名 "env": { "ATLAS_PUBLIC_KEY": "YOUR_ATLAS_PUBLIC_KEY", // MongoDB Atlas 公钥,请替换为你的实际公钥 "ATLAS_PRIVATE_KEY": "YOUR_ATLAS_PRIVATE_KEY" // MongoDB Atlas 私钥,请替换为你的实际私钥 } }
配置说明:
- 'serverName': 为服务器配置指定一个名称,方便在MCP客户端中识别和管理。
- 'command': 指定用于启动服务器的命令,通常为 'npx' (用于运行本地node包) 或 'node' (如果直接运行js文件)。
- 'args': 一个字符串数组,包含传递给启动命令的参数。对于 'mcp-mongodb-atlas',这里使用包名 'mcp-mongodb-atlas'。
- 'env': 一个JSON对象,用于设置环境变量。
- 'ATLAS_PUBLIC_KEY': 必须配置,您的MongoDB Atlas API 公钥。您需要在MongoDB Atlas控制台中创建API Keys并获取公钥。
- 'ATLAS_PRIVATE_KEY': 必须配置,您的MongoDB Atlas API 私钥。您需要在MongoDB Atlas控制台中创建API Keys并获取私钥。
重要提示:
- 您需要在 MongoDB Atlas 控制台 中创建API Keys,并赋予API Keys 相应的权限,以便此MCP服务器能够管理您的Atlas资源。
- 将 'YOUR_ATLAS_PUBLIC_KEY' 和 'YOUR_ATLAS_PRIVATE_KEY' 替换为您实际的API Keys。
基本使用方法
- 启动MCP客户端: 打开并配置好您的MCP客户端(例如 Cline, Cursor, Claude Desktop)。
- 配置MCP服务器: 在MCP客户端的设置中,添加上面提供的服务器配置信息,并填入您的MongoDB Atlas API Keys。
- 使用LLM指令: 在MCP客户端中,使用自然语言指令调用已注册的工具来管理MongoDB Atlas资源。例如,您可以输入类似 “创建一个名为 'my-cluster' 的MongoDB集群” 的指令,客户端会将指令转换为对MCP服务器的工具调用,从而在MongoDB Atlas中创建集群。
具体可使用的工具名称和参数,请参考仓库 'README.md' 文件中 "Features - MCP Tools" 部分的描述。
信息
分类
数据库与文件