ClickHouse MCP Server

ClickHouse MCP Server

未知

GitHub
Created ByClickHouseClickHouse

简介

ClickHouse MCP 是一个允许 Claude 直接与您的 ClickHouse 数据库通信的服务。

PyPI - 版本

主要功能

  • 执行只读查询 - 对您的 ClickHouse 数据库执行安全的查询
  • 列出数据库 - 查看可用的数据库
  • 列出表格 - 查看特定数据库中的所有表

设置步骤

  1. 打开 Claude Desktop 配置文件:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%/Claude/claude_desktop_config.json

  2. 添加以下配置（根据您的环境调整值）:

{
  "mcpServers": {
    "mcp-clickhouse": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "mcp-clickhouse",
        "--python",
        "3.13",
        "mcp-clickhouse"
      ],
      "env": {
        "CLICKHOUSE_HOST": "<clickhouse-host>",
        "CLICKHOUSE_PORT": "<clickhouse-port>",
        "CLICKHOUSE_USER": "<clickhouse-user>",
        "CLICKHOUSE_PASSWORD": "<clickhouse-password>",
        "CLICKHOUSE_SECURE": "true",
        "CLICKHOUSE_VERIFY": "true"
      }
    }
  }
}

  1. 找到 uv 命令的绝对路径（使用 which uv），并在配置中相应更新

  2. 重启 Claude Desktop 应用

快速测试

要使用 ClickHouse SQL Playground 快速测试，使用以下配置:

{
  "mcpServers": {
    "mcp-clickhouse": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "mcp-clickhouse",
        "--python",
        "3.13",
        "mcp-clickhouse"
      ],
      "env": {
        "CLICKHOUSE_HOST": "sql-clickhouse.clickhouse.com",
        "CLICKHOUSE_PORT": "8443",
        "CLICKHOUSE_USER": "demo",
        "CLICKHOUSE_PASSWORD": "",
        "CLICKHOUSE_SECURE": "true",
        "CLICKHOUSE_VERIFY": "true"
      }
    }
  }
}

配置选项

必需环境变量

  • CLICKHOUSE_HOST - 服务器主机名
  • CLICKHOUSE_USER - 用户名
  • CLICKHOUSE_PASSWORD - 密码

可选环境变量

  • CLICKHOUSE_PORT - 端口号（默认：HTTPS 为 8443，HTTP 为 8123）
  • CLICKHOUSE_SECURE - 启用/禁用 HTTPS（默认："true"）
  • CLICKHOUSE_VERIFY - 启用/禁用证书验证（默认："true"）
  • CLICKHOUSE_DATABASE - 默认数据库
  • CLICKHOUSE_CONNECT_TIMEOUT - 连接超时（默认：30秒）
  • CLICKHOUSE_SEND_RECEIVE_TIMEOUT - 请求超时（默认：300秒）