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 实例可以访问。
• 验证配置文件是否正确，特别是路径和参数的位置。
• 检查是否有防火墙或网络限制阻止连接到数据库实例。