Cockroachdb MCP Server

🚀 CockroachDB MCP 服务器

CockroachDB MCP 服务器可连接到 CockroachDB 实例，将数据库和表架构作为资源公开，支持运行 SQL 查询，并能提供查询分析提示，助力用户高效管理和操作数据库。

🚀 快速开始

此 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 上可访问。