MCP Clickhouse

🚀 ClickHouse MCP 服務器

ClickHouse MCP 服務器提供了一系列工具，可在 ClickHouse 集群上執行 SQL 查詢、列出數據庫和表等操作。通過簡單的配置步驟，你可以快速安裝並使用該服務器，同時也支持開發環境的搭建與測試。

✨ 主要特性

工具

• 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. 設置憑據文件：使用 ClickHouse 憑據設置 .env.production 文件：

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

3. 安裝服務器：運行 fastmcp install mcp_clickhouse/mcp_server.py -f .env.production 來安裝服務器。
4. 重啟應用：重啟 Claude Desktop。

📚 詳細文檔

開發環境搭建

1. 啟動 ClickHouse 集群：在 test-services 目錄下運行 docker compose up -d 以啟動 ClickHouse 集群。
2. 配置環境變量：將以下變量添加到根目錄的 .env 文件中：

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

3. 安裝依賴項：運行 uv sync 來安裝依賴項。要安裝 uv 請按照 此處 的說明進行操作。然後執行 source .venv/bin/activate。
4. 啟動 MCP 服務器：為了方便測試，可以運行 fastmcp dev mcp_clickhouse/mcp_server.py 來啟動 MCP 服務器。