Clickhouse MCP server

Clickhouse MCP server

site icon
2025.03.18 0
Python数据库服务查询执行数据库
Clickhouse MCP server 是一个专为 Clickhouse 数据库设计的 MCP 服务项目,提供数据库连接和查询执行功能。它支持通过环境变量配置 Clickhouse 服务器连接参数,并提供了两个主要工具:`connect_database` 用于连接特定数据库,`execute_query` 用于执行 SQL 查询并返回 JSON 格式的结果。
View on GitHub

Overview

基本能力

产品定位

Clickhouse MCP server 是一个专为 Clickhouse 数据库设计的 MCP 服务项目,旨在简化数据库连接和查询操作。

核心功能

  • 数据库连接:通过 connect_database 工具连接特定的 Clickhouse 数据库。
  • 查询执行:通过 execute_query 工具执行 SQL 查询,支持多查询同时执行。
  • 环境变量配置:支持通过环境变量配置 Clickhouse 服务器连接参数。

适用场景

  • 需要快速连接和操作 Clickhouse 数据库的场景。
  • 需要执行复杂 SQL 查询并获取 JSON 格式结果的场景。
  • 需要在开发环境中快速调试 Clickhouse 数据库操作的场景。

工具列表

  • connect_database:连接特定的 Clickhouse 数据库。
  • 参数:database(数据库名称)。
  • 返回:连接成功的确认信息。
  • execute_query:执行 Clickhouse 查询。
  • 参数:query(SQL 查询)。
  • 返回:查询结果的 JSON 格式。
  • 支持多查询同时执行(用分号分隔)。

常见问题解答

  • 调试困难:由于 MCP 服务器通过 stdio 运行,调试可能较为困难。建议使用 MCP Inspector 进行调试。

使用教程

使用依赖

无特殊前置依赖,直接安装即可。

安装教程

使用 uvpip 安装:

uv pip install clickhouse-mcp-server

pip install clickhouse-mcp-server

调试方式

使用 MCP Inspector 进行调试:

npx @modelcontextprotocol/inspector uv --directory /path/to/project run clickhouse-mcp-server

启动后,Inspector 会显示一个 URL,可在浏览器中访问以开始调试。

许可证

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