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 Desktop

1. 打開你的 Claude 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 Desktop

使用 Cline

1. 打開你的 Cline 配置文件，從擴展設置中選擇“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 管理界面 API。確保此令牌安全。

故障排除

• 如果遇到連接問題，請檢查數據庫憑據並確保 CockroachDB 實例可以從你的機器訪問。
• 對於 SQL 錯誤，請查看服務器日誌獲取詳細錯誤消息。
• 如果 Claude 無法看到服務器，請驗證配置文件是否格式正確且到 server.js 文件的路徑正確。
• 對於集群元數據資源，確保提供了有效的身份驗證令牌，並且管理界面在端口 8080 上可訪問。