🚀 ClickHouse MCP 服务器
一个用于 ClickHouse 的 MCP 服务器，提供 MCP 协议支持并可与 ClickHouse 集成，还能执行 SQL 查询和其他 ClickHouse 操作。
🚀 快速开始
按照以下步骤，您可以轻松配置并运行 ClickHouse MCP 服务器。
✨ 主要特性
- 提供 MCP 协议支持，与 ClickHouse 集成。
- 支持执行 SQL 查询和其他 ClickHouse 操作。
💻 使用示例
基础用法
# 示例：查询表中数据
SELECT * FROM table_name;
# 示例：列出所有数据库
SHOW DATABASES;
# 示例：列出指定数据库中的表
USE database_name;
SHOW TABLES;
📦 安装指南
环境要求
- 安装 Python 3.10 或更高版本。
- 安装 ClickHouse 数据库。
快速启动（使用 Docker）
# 启动 ClickHouse 容器
docker-compose up -d
# 进入容器
docker exec -it clickhouse bash
📚 详细文档
配置
在配置文件中添加以下内容：
{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-clickhouse",
"--python",
"3.13",
"mcp-clickhouse"
],
"env": {
"CLICKHOUSE_HOST": "" ,
"CLICKHOUSE_USER": "" ,
"CLICKHOUSE_PASSWORD": ""
}
}
}
}
示例配置
本地开发环境
# 必填变量
CLICKHOUSE_HOST=localhost
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse
# 可选变量（覆盖默认值）
CLICKHOUSE_SECURE=false # 使用 8123 端口
CLICKHOUSE_VERIFY=false
ClickHouse 云环境
# 必填变量
CLICKHOUSE_HOST=your-instance.clickhouse.cloud
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=your-password
# 可选变量（使用安全默认值）
# CLICKHOUSE_SECURE=true # 使用 8443 端口
# CLICKHOUSE_DATABASE=your_database
ClickHouse SQL Playground
CLICKHOUSE_HOST=sql-clickhouse.clickhouse.com
CLICKHOUSE_USER=demo
CLICKHOUSE_PASSWORD=
# 默认使用 HTTPS 和 8443 端口
⚠️ 注意事项
⚠️ 重要提示
配置文件中的环境变量可以设置为
.env文件或直接在终端中设置。
💡 使用建议
生产环境中请确保
CLICKHOUSE_VERIFY设置为true，以保障数据安全。