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

<details> <summary>开发/未发布服务器配置</summary>

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

</details> <details> <summary>已发布服务器配置</summary>

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

</details>

通过 Smithery 安装

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

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

开发

构建和发布

为了准备分发包：

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

uv sync

2. 构建包分布：

uv build

这将在 dist/ 目录中创建源代码和轮子分布。

3. 发布到 PyPI：

uv publish

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

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

调试

由于 MCP 服务器通过标准 I/O 运行，调试可能会很困难。为了获得最佳调试体验，我们强烈推荐使用 MCP Inspector。

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

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

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