README
🚀 MCP MongoDB 服务器
MCP MongoDB 服务器是一款便捷的工具,可帮助用户轻松管理 MongoDB 数据库,支持多种配置选项和高级功能,满足不同场景的使用需求。
🚀 快速开始
启动 MCP MongoDB 服务器,你可以使用以下命令:
mcp-mongo-server --start
若要停止服务器,可执行:
mcp-mongo-server --stop
查看服务器状态,使用:
mcp-mongo-server --status
📦 安装指南
使用 npm 安装
npm install mcp-mongo-server
全局安装
npm install -g mcp-mongo-server
示例运行
mcp-mongo-server --db=mongodb://localhost:27017/myDatabase
📚 详细文档
配置选项
数据库连接字符串
指定 MongoDB 连接字符串:
--db=mongodb://[username:password@]host1[:port1][,host2[:port2],...][/database]
端口配置
设置 MCP 服务器端口(默认为 9005):
--port=9005
高级功能
插件支持
通过 plugins 目录加载自定义插件。
扩展协议
遵循 MCP 协议扩展规则,添加自定义命令处理。
💻 使用示例
基础用法
查询操作
// 基本查询
{
"collection": "users",
"filter": { "age": { "$gt": 30 } },
"projection": { "name": 1, "email": 1 }
}
// 索引解释
{
"collection": "posts",
"explain": true,
"query": { "author": "user1" }
}
// 聚合操作
{
"collection": "orders",
"$group": {
"_id": "$customerId",
"total": { "$sum": "$amount" }
},
"$sort": { "total": -1 }
}
高级用法
简单查询脚本
{
"operation": "query",
"collection": "users",
"filter": { "age": { "$gt": 30 } },
"projection": { "name": 1, "_id": 0 }
}
插件开发示例
// plugin.js
module.exports = {
handleCommand: function(cmd) {
// 处理自定义命令
return customResponse;
}
};
🔧 技术细节
故障排除
常见问题
- 无法连接 MongoDB:检查连接字符串是否正确,确保 MongoDB 服务已启动。
- 端口冲突:尝试使用不同的端口号。
联系支持
加入 MCP 用户群或访问 GitHub 仓库提交问题。
📄 许可证
MCP MongoDB 服务器遵循 MIT 许可证,允许自由使用、修改和分发。更多详情请参考项目仓库中的 LICENSE 文件。
Scan to contact