Dhartunian Cockroachdb MCP Server

🚀 CockroachDB 管理控制平面 (MCP) 服務器

CockroachDB 管理控制平面 (MCP) 服務器可連接到 CockroachDB 實例，將數據庫和表模式作為資源暴露，還能運行 SQL 查詢並提供查詢分析提示，為數據庫管理提供便利。

🚀 快速開始

CockroachDB 管理控制平面 (MCP) 服務器可連接到 CockroachDB 實例，將數據庫和表模式作為資源暴露，還能運行 SQL 查詢並提供查詢分析提示，為數據庫管理提供便利。

✨ 主要特性

資源

• postgres://{host}/databases/{database} - 獲取特定數據庫的信息
• postgres://{host}/databases/{database}/tables/{table}/schema - 獲取特定表的模式
• postgres://{host}/cluster-metadata/{resource} - 獲取集群元數據（需要身份驗證令牌）
  • 當前支持：nodes - 集群節點信息

工具

• query - 執行 SQL 查詢，帶執行計劃分析選項

📦 安裝指南

1. 克隆此倉庫
2. 安裝依賴項：

   pnpm install
   

3. 構建項目：

   npx tsc
   

⚠️ 重要提示

在本地使用 MCP 服務器之前，必須使用 tsc 進行構建。

📚 詳細文檔

配置

服務器需要一個數據庫 URL 作為命令行參數，並可選地接受身份驗證令牌以訪問管理控制檯端點：

node dist/server.js postgres://user:password@host:port/database [auth_token]

身份驗證令牌用於訪問集群元數據資源。

使用 Claude for Desktop

1. 打開您的 Claude for Desktop 應用配置：

   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%\Claude\claude_desktop_config.json`

2. 添加您的服務器配置：

{
  "mcpServers": {
    "cockroachdb": {
      "command": "node",
      "args": [
        "/path/to/cockroachdb-mcp-server/dist/server.js", 
        "postgres://user:password@host:port/database",
        "your_auth_token"
      ]
    }
  }
}

3. 重啟 Claude for Desktop

使用 Cline

1. 打開您的 Cline 配置文件（從擴展設置中找到“MCP 服務器”）。選擇“配置 MCP 服務器”。

2. 添加您的服務器配置：

{
  "mcpServers": {
    "crdb": {
      "command": "node",
      "args": [
        "/path/to/cockroachdb-mcp-server/dist/server.js",
        "postgres://root@127.0.0.1:26257/testdb",
        "your_auth_token"
      ]
    }
  }
}

3. 重啟 Cline 或啟動新會話

示例查詢

以下是您可以詢問 Claude 的一些示例問題：

1. “我的 CockroachDB 實例中有哪些數據庫？”
2. “能否顯示‘users’表在‘testdb’數據庫中的模式？”
3. “運行此查詢：SELECT * FROM users LIMIT 10”
4. “調試此查詢並提出改進建議：SELECT * FROM orders WHERE customer_id = 123”
5. “顯示所有 CockroachDB 集群節點的信息”

安全注意事項

⚠️ 重要提示

• 在配置數據庫訪問時要小心。如果您只需要查詢數據，考慮使用只讀用戶。
• 身份驗證令牌用於訪問 CockroachDB 管理控制檯 API。確保將此令牌安全保管。

故障排除

⚠️ 重要提示

• 如果遇到連接問題，請檢查您的數據庫憑證，並確保 CockroachDB 實例可以訪問。
• 驗證配置文件是否正確，特別是路徑和參數的位置。
• 檢查是否有防火牆或網絡限制阻止連接到數據庫實例。