ClickHouse MCP Server

ClickHouse MCP Server

site icon
2024.12.19 1
Python数据库中间件AI集成数据库开发效率
ClickHouse MCP Server 是一个为 ClickHouse 数据库设计的 Model Context Protocol (MCP) 服务器,旨在实现 ClickHouse 数据库与大型语言模型 (LLMs) 及其他 AI 应用的无缝集成。它提供了数据库和表的资源列表、表结构检索、SELECT 查询执行等功能,并通过 MCP 协议实现安全高效的通信。
View on GitHub

Overview

基本能力

产品定位

ClickHouse MCP Server 是一个中间件服务,专注于为 ClickHouse 数据库提供与 AI 应用的集成能力。

核心功能

  • 列出 ClickHouse 数据库和表作为资源
  • 检索表结构
  • 在 ClickHouse 数据库上执行 SELECT 查询
  • 使用 MCP 协议进行安全高效的通信

适用场景

  • AI 应用与 ClickHouse 数据库的集成
  • 需要从 ClickHouse 数据库中检索数据用于 LLM 或其他 AI 模型的场景
  • 开发需要与 ClickHouse 交互的 AI 工具或服务

工具列表

  • server.py: 主服务程序,启动 MCP 服务器
  • pytest: 用于运行测试

常见问题解答

  • 如何配置 ClickHouse 连接?通过环境变量或直接修改 server.py 中的 get_clickhouse_client 函数
  • 如何运行测试?使用 pytest tests/ 命令

使用教程

使用依赖

  • Python 3.10+
  • ClickHouse server

安装教程

  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 函数

调试方式

  1. 启动服务器: python clickhouse_mcp_server/server.py

  2. 运行测试: pytest tests/

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。