Clickhouse MCP Server

🚀 ClickHouse MCP 服務器

本項目實現了一個模型上下文協議（MCP）服務器，專為 ClickHouse 設計。它能讓 ClickHouse 數據庫與大型語言模型 (LLMs) 及其他 AI 應用程序實現無縫集成，極大拓展了 ClickHouse 的應用場景。

🚀 快速開始

運行服務器前，需完成安裝步驟。安裝完成後，執行以下命令即可啟動服務器：

python clickhouse_mcp_server/server.py

服務器啟動後，將開始監聽 MCP 請求。

✨ 主要特性

• 可將 ClickHouse 數據庫和表作為資源列出。
• 支持獲取表結構。
• 能執行 ClickHouse 數據庫上的 SELECT 查詢。
• 藉助 MCP 協議，實現安全且高效的通信。

📦 安裝指南

1. 克隆倉庫：

   git clone https://github.com/ThomAub/clickhouse_mcp_server.git
   cd clickhouse_mcp_server
   

2. 安裝所需的包：

   uv sync --all-extras
   

3. 在環境變量中設置 ClickHouse 連接詳細信息，或更新 server.py 中的 get_clickhouse_client 函數。

💻 使用示例

基礎用法

運行服務器：

python clickhouse_mcp_server/server.py

高級用法

暫無高級用法示例。

📚 詳細文檔

測試

使用 pytest 運行測試：

pytest tests/

貢獻

歡迎貢獻！請隨意提交 Pull Request！

📄 許可證

該項目根據 MIT 許可證發佈。