Clickhouse MCP Server

🚀 ClickHouse MCP サーバー

このサーバーは、ClickHouse 用に実装されたモデルコンテキストプロトコル (MCP) サーバーです。AI アシスタントに対して、安全で構造化されたデータベースの探索と分析方法を提供します。これにより、AI アシスタントはテーブルの一覧表示、データの読み取り、SQL クエリの実行が可能で、制御されたインターフェースを通じて責任あるデータベースアクセスを保証します。

🚀 クイックスタート

この ClickHouse MCP サーバーを使用することで、AI アシスタントが安全に ClickHouse データベースを探索し、分析することができます。

📦 インストール

環境変数の設定

以下の環境変数を設定してください。

CLICKHOUSE_HOST=localhost    
CLICKHOUSE_PORT=8123         
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=CHANGE_TO_YOUR_PASSWORD
CLICKHOUSE_DATABASE=default

コマンドライン引数を使用する場合

以下のコマンドライン引数を使用して設定することもできます。

• --host データベースホスト
• --port データベースポート
• --user データベースユーザー名
• --password データベースパスワード
• --database データベース名

💻 使用例

基本的な使用法

ClickHouse 内のデータの準備

dev_contribute.md ファイル内の SQL 文を参照して、ClickHouse 内にデータを用意してください。

Cline で AI アシスタントに質問する

以下のように質問を行います。

What is the sales volume in each region? Which product is the best - selling?

CLINE での設定

VSCode、Cline 拡張またはその他の MCP クライアントで MCP サーバーを設定します。以下は設定例です。

{
  "mcpServers": {
    "clickhouse": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/clickhouse_mcp_server",
        "run",
        "-m",
        "clickhouse_mcp_server.server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_PORT": "8123",
        "CLICKHOUSE_USER": "default",
        "CLICKHOUSE_PASSWORD": "CHANGE_TO_YOUR_PASSWORD",
        "CLICKHOUSE_DATABASE": "default"
      }
    }
    
  }
}

📄 ライセンス

APACHE - 詳細については LICENSE ファイルを参照してください。

🤝 貢献

詳細については dev_contribute.md を参照してください。

決条件

• uv パッケージマネージャー付きの Python
• ClickHouse のインストール
• MCP サーバーの依存関係

🙏 謝辞

このライブラリの実装は以下の 3 つのリポジトリからインスピレーションを得ており、それらのコードを参考にしています。オープンソース精神に敬意を表します！

• GreptimeTeam/greptimedb-mcp-server
• ktanaka101/mcp-server-duckdb
• designcomputer/mysql_mcp_server)

ありがとうございます！