Clickhouse

🚀 ClickHouse MCP 服务器

ClickHouse MCP 服务器是一个基于 ClickHouse 数据库的项目，它为用户提供了便捷的数据库连接和查询执行功能，可有效提升数据处理效率。

🚀 快速开始

安装

Claude Desktop

不同系统下的配置文件路径如下：

• 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 自动安装 ClickHouse 数据库集成服务器以在 Claude Desktop 上运行，可使用以下命令：

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

✨ 主要特性

该服务器提供了两个实用工具：

• connect_database：用于连接到特定的 ClickHouse 数据库。
  • database 参数：要连接的数据库名称（字符串）。
  • 成功连接后返回确认消息。
• execute_query：用于执行 ClickHouse 查询。
  • query 参数：要执行的 SQL 查询/多个查询（字符串）。
  • 返回 JSON 格式的查询结果。
  • 多个查询可以通过分号分隔发送。

📦 安装指南

你可以使用以下两种方式安装该包：

使用 uv 命令

uv pip install clickhouse-mcp-server

使用 pip

pip install clickhouse-mcp-server

📚 详细文档

配置

服务器使用以下环境变量进行配置：

开发

构建和发布

为了将包准备好分发，可按以下步骤操作：

1. 同步依赖项并更新锁定文件：

uv sync

2. 构建发行版：

uv build

这将在 dist/ 目录下创建源代码和轮格式发行版。 3. 发布到 PyPI：

uv publish

注意：你需要通过环境变量或命令行参数设置 PyPI 凭据：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或者用户名/密码：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

调试

由于 MCP 服务器通过标准输入输出运行，调试可能会有挑战。为了获得最佳的调试体验，我们强烈推荐使用 MCP Inspector。 你可以通过以下命令启动 MCP Inspector：

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

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