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 许可证发布。