ClickHouse MCP 服务器

已迁移至 https://github.com/ClickHouse/mcp-clickhouse

一个用于 ClickHouse 的 MCP 服务器。

功能

工具

• run_select_query

  • 在您的 ClickHouse 集群上执行 SQL 查询。
  • 输入: sql (字符串): 要执行的 SQL 查询。
  • 所有 ClickHouse 查询都使用 readonly = 1 运行，以确保它们是安全的。

• list_databases

  • 列出您 ClickHouse 集群上的所有数据库。

• list_tables

  • 列出数据库中的所有表。
  • 输入: database (字符串): 数据库的名称。

配置

注意: 这是一个临时配置过程，一旦包发布后将会有显著改进。

1. 运行 uv sync 安装依赖项。要安装 uv 请按照这里的说明进行操作。然后运行 source .venv/bin/activate。

2. 设置 .env.production 文件，填写 ClickHouse 凭证。

CLICKHOUSE_HOST=<CLICKHOUSE_HOST>
CLICKHOUSE_PORT=<CLICKHOUSE_PORT>
CLICKHOUSE_USER=<CLICKHOUSE_USER>
CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>

1. 运行 fastmcp install mcp_clickhouse/mcp_server.py -f .env.production 安装服务器。

2. 重启 Claude Desktop。

开发

1. 在 test-services 目录下运行 docker compose up -d 启动 ClickHouse 集群。

2. 在仓库根目录下的 .env 文件中添加以下变量。

CLICKHOUSE_HOST=localhost
CLICKHOUSE_PORT=8123
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse

1. 运行 uv sync 安装依赖项。要安装 uv 请按照这里的说明进行操作。然后运行 source .venv/bin/activate。

2. 为了方便测试，您可以运行 fastmcp dev mcp_clickhouse/mcp_server.py 来启动 MCP 服务器。