Mongo MCP Server

🚀 MongoDB MCP 服務器

這是一個專為 MongoDB 數據庫設計的模型上下文協議 (MCP) 服務器。它能深入分析 MongoDB 數據庫的結構，並藉助人工智能技術生成精準的查詢，極大提升數據庫操作效率。

🚀 快速開始

本服務器使用前需進行安裝與運行，以下是詳細步驟：

1. 安裝依賴：

npm install

2. 構建：

npm run build

3. 啟動服務器：

node dist/index.js "mongodb://localhost:27017"

✨ 主要特性

1. ERD 生成（generateErd）

此功能可分析數據庫的集合結構並生成實體關係圖 (ERD)。

• 輸入參數：

{
    "database": "string",
    "collections": ["string"],  // 可選
    "format": "mermaid" | "json"  // 默認值: "mermaid"
}

• 使用示例：

{
    "database": "test",
    "format": "mermaid"
}

2. 查詢生成（generateQuery）

基於自然語言描述生成 MongoDB 查詢，通過分析數據庫的實際結構，提供準確的查詢。

• 輸入參數：

{
    "database": "string",
    "collection": "string",
    "description": "string",
    "type": "mongodb" | "mongoose",  // 默認值: "mongodb"
    "includeExplanation": boolean  // 默認值: true
}

• 使用示例：

{
    "database": "test",
    "collection": "users",
    "description": "查找今天新註冊的用戶",
    "type": "mongodb"
}

📦 安裝指南

安裝與運行

1. 安裝依賴：

npm install

2. 構建：

npm run build

3. 啟動服務器：

node dist/index.js "mongodb://localhost:27017"

Claude Desktop 設置

在 macOS 上與 Claude Desktop 一起使用，請按照以下步驟配置：

1. 配置文件位置：~/Library/Application Support/Claude/claude_desktop_config.json
2. 添加 MCP 服務器配置：

{
    "mcp": {
        "servers": [
            {
                "name": "mongodb",
                "command": "node /path/to/mongo-mcp-server/dist/index.js mongodb://localhost:27017/test"
            }
        ]
    }
}

3. 重啟 Claude Desktop

📚 詳細文檔

開發

項目結構

src/
├── index.ts          # 主服務器代碼
├── tools/
│   ├── generateErd.ts    # ERD 生成工具
│   └── generateQuery.ts  # 查詢生成工具

添加新工具

1. 在 src/tools 目錄下創建新的工具文件。
2. 實現工具接口：

export const newTool = {
    parameters: {
        // 參數定義
    },
    async execute(params: any, context: { client: MongoClient }) {
        // 工具邏輯實現
    },
};

3. 在 src/index.ts 註冊新工具。