CockroachDB MCP 服务器

此 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 作为命令行参数，并且可以选择接受一个身份验证令牌来访问管理 UI 端点：

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. 从扩展设置中的“MCP 服务器”打开您的 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. "你能给我展示 'testdb' 数据库中 'users' 表的模式吗？"
3. "在我的数据库上运行此查询：SELECT * FROM users LIMIT 10"
4. "调试此查询并提出改进建议：SELECT * FROM orders WHERE customer_id = 123"
5. "向我展示我的 CockroachDB 集群中所有节点的信息"

安全注意事项

• 配置数据库访问时要小心。 如果您只需要查询数据，请考虑使用只读用户进行连接。
• 身份验证令牌用于访问 CockroachDB 管理 UI API。 确保妥善保管此令牌。

故障排除

• 如果遇到连接问题，请验证您的数据库凭据，并确保可以从您的机器访问 CockroachDB 实例。
• 对于 SQL 错误，请检查服务器日志以获取详细的错误消息。
• 如果 Claude 无法看到服务器，请验证配置文件格式是否正确，以及 server.js 文件的路径是否正确。
• 对于集群元数据资源，请确保您已提供有效的身份验证令牌，并且可以在端口 8080 上访问管理 UI。