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"
      ]
    }
  }
}

1. 重启Claude for Desktop

与Cline配合使用

1. 从扩展设置下的“MCP Servers”打开您的Cline配置文件。选择“Configure MCP Servers”。

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"
      ]
    }
  }
}

1. 重启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文件的路径正确。
• 对于集群元数据资源，请确保提供了有效的认证令牌并且管理UI在8080端口上可访问。