什么是ClickHouse MCP 服务器？

ClickHouse MCP 服务器是一个轻量级工具，用于在ClickHouse数据库上执行安全的SQL查询和管理数据库表。它通过Model Context Protocol（MCP）提供便捷的数据访问接口。

如何使用ClickHouse MCP 服务器？

只需几步即可设置和运行ClickHouse MCP服务器。您可以通过简单的命令行工具执行SQL查询、列出数据库和表。

适用于需要快速访问和分析ClickHouse数据库的企业和开发者，例如数据分析、报表生成和实时监控。

执行SQL查询安全地执行只读SQL查询，确保操作不会对数据库造成影响。

列出所有数据库轻松查看ClickHouse集群中的所有数据库。

列出表列出指定数据库中的所有表。

优势

易于安装和配置

支持安全的只读查询

与ClickHouse深度集成

局限性

仅支持只读查询

需要ClickHouse服务器环境

安装依赖

运行`uv sync`命令来安装所需的依赖项。如果您尚未安装`uv`，请参考官方文档进行安装。

配置环境变量

在`.env.production`文件中添加ClickHouse的连接信息。

启动MCP服务器

使用`fastmcp install`命令启动MCP服务器。

查询用户表执行SQL查询以获取用户表中的前10条记录。

列出所有数据库获取ClickHouse集群中的所有数据库列表。

如何确保查询的安全性？

是否支持多节点集群？

如何卸载MCP服务器？

ClickHouse MCP 服务器提供了一系列工具，可在 ClickHouse 集群上执行 SQL 查询、列出数据库和表等操作。通过简单的配置步骤，你可以快速安装并使用该服务器，同时也支持开发环境的搭建与测试。

run_select_query
- 功能：在你的 ClickHouse 集群上执行 SQL 查询。
- 输入：sql (字符串)，即要执行的 SQL 查询。
- 安全保障：所有 ClickHouse 查询都会以 readonly = 1 运行，确保它们是安全的。
list_databases
- 功能：列出你的 ClickHouse 集群上的所有数据库。
list_tables
- 功能：在指定数据库中列出所有表。
- 输入：database (字符串)，即数据库名称。

⚠️ 重要提示

这是一个临时的配置流程，一旦包发布将会得到显著改进。

安装依赖项：运行 uv sync 来安装依赖项。要安装 uv 请按照此处的说明进行操作。然后执行 source .venv/bin/activate。
设置凭据文件：使用 ClickHouse 凭据设置 .env.production 文件：

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

安装服务器：运行 fastmcp install mcp_clickhouse/mcp_server.py -f .env.production 来安装服务器。
重启应用：重启 Claude Desktop。

启动 ClickHouse 集群：在 test-services 目录下运行 docker compose up -d 以启动 ClickHouse 集群。
配置环境变量：将以下变量添加到根目录的 .env 文件中：

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

安装依赖项：运行 uv sync 来安装依赖项。要安装 uv 请按照此处的说明进行操作。然后执行 source .venv/bin/activate。
启动 MCP 服务器：为了方便测试，可以运行 fastmcp dev mcp_clickhouse/mcp_server.py 来启动 MCP 服务器。