Clickhouse MCP server

Clickhouse MCP 服务

Clickhouse 数据库 MCP 服务项目。

安装

你可以使用 uv 安装此软件包：

uv pip install clickhouse-mcp-server

也可以使用 pip：

pip install clickhouse-mcp-server

组件

工具

此服务提供两个工具：

• connect_database：连接到指定的 Clickhouse 数据库

  • database 参数：要连接的数据库名称（字符串）
  • 连接成功时返回确认消息

• execute_query：执行 Clickhouse 查询

  • query 参数：要执行的 SQL 查询（字符串）
  • 以 JSON 格式返回查询结果
  • 可以使用分号分隔并发送多个查询

配置

此服务使用以下环境变量：

• CLICKHOUSE_HOST：Clickhouse 服务地址（默认值："localhost"）
• CLICKHOUSE_USER：Clickhouse 用户名（默认值："root"）
• CLICKHOUSE_PASSWORD：Clickhouse 密码（默认值：""）
• CLICKHOUSE_DATABASE：初始数据库（可选）
• CLICKHOUSE_READONLY：只读模式（设为 1/true 以启用，默认值：false）

快速入门

安装

Claude Desktop

MacOS：~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/burakdirin/Projects/clickhouse-mcp-server",
        "run",
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}

{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uvx",
      "args": [
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}

通过 Smithery 安装

若要通过 Smithery 为 Claude Desktop 自动安装 Clickhouse 数据库集成服务：

npx -y @smithery/cli install @burakdirin/clickhouse-mcp-server --client claude

开发

构建和发布

准备分发软件包：

1. 同步依赖项并更新锁文件：

uv sync

2. 构建软件包分发文件：

uv build

这将在 dist/ 目录中创建源码分发包和 wheel 分发包。

3. 发布到 PyPI：

uv publish

注意：你需要通过环境变量或命令标志设置 PyPI 凭据：

• Token：--token 或 UV_PUBLISH_TOKEN
• 或用户名/密码：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

调试

由于 MCP 服务通过 stdio 运行，调试可能颇具挑战。为获得最佳调试体验，我们强烈建议使用 MCP Inspector。

你可以通过 npm 使用以下命令启动 MCP Inspector：

npx @modelcontextprotocol/inspector uv --directory /Users/burakdirin/Projects/clickhouse-mcp-server run clickhouse-mcp-server

启动后，Inspector 会显示一个 URL，你可以在浏览器中访问该 URL 开始调试。