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

コンポーネント

ツール

サーバーは次の 2 つのツールを提供します。

  • 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 資格情報を設定する必要があります。

  • トークン: --tokenまたはUV_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 がインスペクタに表示されます。

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

Claude AIがClickhouseデータベースと連携できるようにするMCPサーバー実装。安全なデータベース接続、クエリ実行、読み取り専用モードのサポート、マルチクエリ機能などの機能を備えています。

  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