CockroachDB MCP Server

CockroachDB MCP Server

site icon
2025.03.22 0
Python数据库中间件数据库连接管理数据库
CockroachDB MCP Server 是一个基于 Model Context Protocol (MCP) 规范实现的服务器,允许用户在 Cursor 中直接与 CockroachDB 数据库进行交互。该服务器提供了丰富的数据库操作功能,包括连接数据库、获取表结构、执行 SQL 查询等,并具备自动重连和连接保持机制,确保连接的稳定性。
View on GitHub

Overview

基本能力

产品定位

CockroachDB MCP Server 是一个数据库中间件服务,专门为 Cursor 提供与 CockroachDB 数据库的交互能力。

核心功能

  • 连接 CockroachDB 数据库
  • 获取数据库中的所有表
  • 获取表结构信息
  • 执行 SQL 查询
  • 提供数据库状态资源
  • 提供 SQL 查询模板
  • 自动重连机制确保连接稳定性
  • 连接保持机制防止连接超时
  • 优雅的进程退出处理
  • 详细的日志记录用于故障排除
  • 支持手动断开连接

适用场景

  • 在 Cursor 中直接操作 CockroachDB 数据库
  • 需要稳定连接和自动恢复的数据库应用
  • 需要详细日志记录的数据库调试场景

工具列表

  1. connect_database: 连接 CockroachDB 数据库
  2. initialize_connection: 初始化数据库连接
  3. disconnect_database: 手动断开数据库连接
  4. get_tables: 获取数据库中的所有表
  5. get_table_schema: 获取指定表的结构信息
  6. execute_query: 执行 SQL 查询

常见问题解答

  1. 连接被拒绝: 确保 CockroachDB 服务器正在运行并且可以从您的机器访问
  2. 认证失败: 检查用户名和密码是否正确
  3. 连接超时: 检查网络连接是否稳定,特别是连接到远程数据库时
  4. 数据库服务器问题: 检查 CockroachDB 服务器是否正常运行

使用教程

使用依赖

  1. 安装 Python 依赖:
pip install -r requirements.txt
  1. 安装 uv:
curl -LsSf https://astral.sh/uv/install.sh | sh

安装教程

通过 Smithery 自动安装:

npx -y @smithery/cli install @Swayingleaves/cockroachdb-mcp-server --client claude

调试方式

  1. 检查日志文件 logs/cockroachdb_mcp.log 了解服务器运行状态
  2. 使用以下配置在 Cursor 中运行:
{
    "mcpServers": {
        "cockroachdb-mcp": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/local/cockroachdb-mcp",
                "run",
                "server.py"
            ],
            "jdbc_url": "jdbc:postgresql://localhost:26257/defaultdb",
            "username": "root",
            "password": "root"
        }
    }
}

许可证

None