🚀 MongoDB Model Context Protocol (MCP) 服务器开发文档

本项目致力于将 MongoDB 数据库功能集成到支持 MCP 的语言模型工具中，为开发者提供便捷、高效且安全的数据库操作体验。

🚀 快速开始

安装依赖

npm install

构建项目

npm run build

开发模式运行

npm run dev

测试

npm test

✨ 主要特性

• 数据库操作：提供对 MongoDB 数据库的基本 CRUD 操作
• 索引管理：创建、删除和列出集合中的索引
• 查询工具：支持复杂查询和投影操作
• 类型安全：使用 Zod 进行输入验证
• 日志记录：详细的日志输出便于调试

📦 安装指南

数据库连接字符串

格式：mongodb://[username:password@]host[:port][/db_name][?options] 示例：

# 带认证的连接
mongodb://admin:password@localhost:27017/mydb

# 不带认证的连接
mongodb://localhost:27017/

💻 使用示例

可用工具

查询工具

• listCollections：列出数据库中的所有集合
• find：查询文档并支持过滤和投影
• insertOne：向集合中插入单个文档
• updateOne：更新集合中的单个文档
• deleteOne：删除集合中的单个文档

索引工具

• createIndex：创建新索引
• dropIndex：删除指定索引
• indexes：列出集合上的所有索引

🔧 技术细节

项目构建技术栈

• TypeScript：用于类型安全的开发
• MongoDB Node.js 驱动程序：实现数据库操作
• Zod：进行数据验证
• MCP SDK：实现服务器接口规范

📚 详细文档

安全注意事项

1. 创建一个具有最小权限的专用 MongoDB 用户
2. 避免在生产环境中使用管理凭证
3. 启用访问日志记录功能
4. 设置适当的读写权限
5. 使用连接字符串参数限制访问（例如 readPreference=secondary）
6. 考虑启用 IP 白名单访问控制

贡献指南

欢迎贡献！请参考以下步骤：

1. Fork 仓库
2. 创建功能分支（例如 git checkout -b feature/amazing-feature）
3. 提交更改（如 git commit -m '添加精彩特性'）
4. 推送到分支（如 git push origin feature/amazing-feature）
5. 提交 Pull Request

📄 许可证

该项目遵循 MIT 协议。详细信息请参阅 LICENSE 文件。