Clickhouse

🚀 ClickHouse MCP 服務器

ClickHouse MCP 服務器是一個基於 ClickHouse 數據庫的項目，它為用戶提供了便捷的數據庫連接和查詢執行功能，可有效提升數據處理效率。

🚀 快速開始

安裝

Claude Desktop

不同系統下的配置文件路徑如下：

• MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/burakdirin/Projects/clickhouse-mcp-server",
        "run",
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}

{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uvx",
      "args": [
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}

通過 Smithery 安裝

要通過 Smithery 自動安裝 ClickHouse 數據庫集成服務器以在 Claude Desktop 上運行，可使用以下命令：

npx -y @smithery/cli install @burakdirin/clickhouse-mcp-server --client claude

✨ 主要特性

該服務器提供了兩個實用工具：

• connect_database：用於連接到特定的 ClickHouse 數據庫。
  • database 參數：要連接的數據庫名稱（字符串）。
  • 成功連接後返回確認消息。
• execute_query：用於執行 ClickHouse 查詢。
  • query 參數：要執行的 SQL 查詢/多個查詢（字符串）。
  • 返回 JSON 格式的查詢結果。
  • 多個查詢可以通過分號分隔發送。

📦 安裝指南

你可以使用以下兩種方式安裝該包：

使用 uv 命令

uv pip install clickhouse-mcp-server

使用 pip

pip install clickhouse-mcp-server

📚 詳細文檔

配置

服務器使用以下環境變量進行配置：

開發

構建和發佈

為了將包準備好分發，可按以下步驟操作：

1. 同步依賴項並更新鎖定文件：

uv sync

2. 構建發行版：

uv build

這將在 dist/ 目錄下創建源代碼和輪格式發行版。 3. 發佈到 PyPI：

uv publish

注意：你需要通過環境變量或命令行參數設置 PyPI 憑據：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或者用戶名/密碼：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

調試

由於 MCP 服務器通過標準輸入輸出運行，調試可能會有挑戰。為了獲得最佳的調試體驗，我們強烈推薦使用 MCP Inspector。 你可以通過以下命令啟動 MCP Inspector：

npx @modelcontextprotocol/inspector uv --directory /Users/burakdirin/Projects/clickhouse-mcp-server run clickhouse-mcp-server

啟動後，Inspector 會顯示一個 URL，你可以在瀏覽器中訪問該 URL 開始調試。