article
README
🚀 ClickHouse MCP 服务器
ClickHouse MCP 服务器是一个专为 ClickHouse 设计的服务器,可帮助用户在 ClickHouse 集群上执行各类操作,如 SQL 查询、数据库和表的列举等。
✨ 主要特性
工具
run_select_query- 功能:在你的 ClickHouse 集群上执行 SQL 查询。
- 输入:
sql(字符串),即要执行的 SQL 查询。 - 安全性:所有 ClickHouse 查询都会以
readonly = 1运行,以确保它们是安全的。
list_databases- 功能:列出你的 ClickHouse 集群上的所有数据库。
- 输入:无。
- 输出:数据库列表。
list_tables- 功能:列出指定数据库中的所有表。
- 输入:
database(字符串),即要列出表的数据库名称。 - 输出:表格列表。
📦 安装指南
要在你的项目中使用这个 MCP 服务器,你需要在 pyproject.toml 或 setup.py 中添加以下配置:
[project.urls]
Homepage = "https://glama.ai/mcp/servers/yvjy4csvo1"
🔧 技术细节
环境变量
你可以通过环境变量来配置 MCP 服务器的行为。以下是支持的环境变量及其作用:
| 变量名 | 作用 |
|--------|------|
| CLICKHOUSE_HOST | 设置 ClickHouse 服务器的主机名或 IP 地址。 |
| CLICKHOUSE_PORT | 设置 ClickHouse 服务器的端口(默认为 8123)。 |
| CLICKHOUSE_USER | 设置连接 ClickHouse 的用户名。 |
| CLICKHOUSE_PASSWORD | 设置连接 ClickHouse 的用户密码。 |
| CLICKHOUSE_DATABASE | 设置要使用的数据库名称(可选,默认为 default)。 |
示例配置
本地开发
# 必需变量
CLICKHOUSE_HOST=localhost
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse
# 可选变量:覆盖默认值
CLICKHOUSE_SECURE=false # 使用端口 8123 自动
CLICKHOUSE_VERIFY=false
ClickHouse Cloud
# 必需变量
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)
扫码联系在线客服