Mongodb

🚀 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 文件。