clickhouse-mcp-server

by burakdirin
Verified

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Provides tools for connecting to a ClickHouse database and executing SQL queries, with support for multiple queries and JSON-formatted results.

Clickhouse MCP 服务器

Clickhouse 数据库 MCP 服务器项目。

安装

您可以使用uv安装该软件包:

uv pip install clickhouse-mcp-server

或者使用pip

pip install clickhouse-mcp-server

成分

工具

服务器提供了两个工具:

  • connect_database :连接到特定的 Clickhouse 数据库
    • database参数:要连接的数据库的名称(字符串)
    • 连接成功时返回确认消息
  • execute_query Clickhouse 查询
    • query参数:要执行的 SQL 查询/查询(字符串)
    • 以 JSON 格式返回查询结果
    • 可以发送多个查询,以分号分隔

配置

服务器使用以下环境变量:

  • CLICKHOUSE_HOST :Clickhouse 服务器地址(默认:“localhost”)
  • CLICKHOUSE_USER :Clickhouse 用户名(默认值:“root”)
  • CLICKHOUSE_PASSWORD :Clickhouse 密码(默认值:“”)
  • CLICKHOUSE_DATABASE :初始数据库(可选)
  • CLICKHOUSE_READONLY :只读模式(设置为 1/true 以启用,默认值:false)

快速入门

安装

克劳德桌面

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自动为 Claude Desktop 安装 Clickhouse 数据库集成服务器:

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

发展

构建和发布

准备分发包:

  1. 同步依赖项并更新锁文件:
uv sync
  1. 构建软件包分发版:
uv build

这将在dist/目录中创建源和轮子分布。

  1. 发布到 PyPI:
uv publish

注意:您需要通过环境变量或命令标志设置 PyPI 凭据:

  • 令牌: --tokenUV_PUBLISH_TOKEN
  • 或用户名/密码: --username / UV_PUBLISH_USERNAME--password / UV_PUBLISH_PASSWORD

调试

由于 MCP 服务器通过 stdio 运行,调试起来可能比较困难。为了获得最佳调试体验,我们强烈建议使用MCP Inspector

您可以使用以下命令通过npm启动 MCP Inspector:

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

启动后,检查器将显示一个 URL,您可以在浏览器中访问该 URL 以开始调试。

-
security - not tested
A
license - permissive license
-
quality - not tested

一个 MCP 服务器实现,使 Claude AI 能够与 Clickhouse 数据库交互。功能包括安全的数据库连接、查询执行、只读模式支持和多查询功能。

  1. Installation
    1. Components
      1. Tools
    2. Configuration
      1. Quickstart
        1. Installation
        2. Installing via Smithery
      2. Development
        1. Building and Publishing
        2. Debugging
      ID: 8rcaf3zosc