项目简介
Mongo MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它充当 LLM(大语言模型)客户端和 MongoDB 数据库之间的桥梁。通过该服务器,LLM 可以利用预定义的工具集,以自然语言指令操作 MongoDB 数据库,实现数据的查询、修改和管理等功能。
主要功能点
- MongoDB 数据库操作: 提供了一系列工具,允许 LLM 执行 MongoDB 的 CRUD(创建、读取、更新、删除)操作,以及索引管理功能。
- SSE 支持: 支持 Server-Sent Events (SSE) 协议,实现与 MCP 客户端的实时通信。
- 工具化能力: 内置丰富的工具集,包括:
- 集合工具: 列出数据库中的集合。
- 文档工具: 查询文档、统计文档数量、插入单个文档、更新单个文档、删除单个文档。
- 索引工具: 创建索引、删除索引、列出集合的索引。
安装步骤
- 前提条件: 确保已安装 Go 语言环境和 MongoDB 数据库服务。
- 下载仓库: 从 GitHub 克隆仓库到本地:
git clone https://github.com/thinking-bzf/mongo-mcp-go.git cd mongo-mcp-go - 配置服务器: 复制 'config.yml.example' 文件并重命名为 'config.yml',根据您的 MongoDB 数据库配置和 MCP 服务器需求修改 'config.yml' 文件中的参数,例如 MongoDB 的连接信息(host, port, user, password, database)和 MCP 服务器的地址、端口等。
- 启动服务器: 在项目根目录下,使用 Go 语言编译并运行 'main.go' 文件:
服务器默认监听 'config.yml' 中 'mcp.address' 配置的地址和端口。go run main.go
服务器配置
MCP 客户端需要配置以下 JSON 格式信息以连接 Mongo MCP Server:
{ "serverName": "mongo-mcp-server", "command": "go", "args": [ "run", "main.go" ], "baseUrl": "http://localhost:8081" }
配置参数说明:
- 'serverName': MCP 服务器的名称,对应 'config.yml' 中的 'mcp.name' 字段。
- 'command': 启动 MCP 服务器的命令,这里使用 'go run' 直接运行 'main.go' 文件。
- 'args': 启动命令的参数,对于 'go run main.go' 来说,参数就是 '["run", "main.go"]'。
- 'baseUrl': MCP 服务器的根 URL,对应 'config.yml' 中的 'mcp.base_url' 字段,用于 SSE 连接。如果使用 Stdio 连接,则不需要配置 'baseUrl'。
注意: 请确保 MCP 客户端能够访问到 Mongo MCP Server 运行的地址和端口。如果 MongoDB 服务和 MCP Server 不在同一台机器上,'config.yml' 中的 'mongo.host' 需要配置为 MongoDB 服务的实际 IP 地址或域名。
基本使用方法
- 启动 Mongo MCP Server: 按照安装步骤启动服务器。
- 配置 MCP 客户端: 在您的 LLM 应用或 MCP 客户端中,配置上述 JSON 格式的服务器连接信息。
- 调用工具: 在 LLM 客户端中,可以使用自然语言指令,通过配置的工具名称和参数来调用 Mongo MCP Server 提供的 MongoDB 操作工具。例如,使用 'Find' 工具查询文档,使用 'InsertOne' 工具插入文档等。
具体工具的使用方法和参数可以参考仓库 'README.md' 文件中 "Available Tools" 部分的描述。
信息
分类
数据库与文件