StarRocks MCPサーバーは、AIアシスタントとStarRocksデータベースの間の架け橋として機能します。複雑なクライアント側設定を必要とせず、直接SQL実行、データベース探索、チャートによるデータ可視化、詳細なスキーマやデータ概要の取得を可能にします。

特徴

• 直接SQL実行: SELECTクエリ(read_query)およびDDL/DMLコマンド(write_query)を実行してください。
• データベース探索: データベースとテーブルを一覧表示し、テーブルスキーマ(starrocks://リソース)を取得します。
• システム情報: proc://リソースパスを通じてStarRocks内部の指標と状態にアクセスできます。
• 詳細な概要: テーブル(table_overview)やデータベース全体の包括的な要略(db_overview)を取得可能で、列定義、行数、サンプルデータが含まれます。
• データ可視化: クエリを実行し、結果から直接Plotlyチャートを生成する(query_and_plotly_chart)。
• インテリジェントキャッシュ: テーブルおよびデータベースの概要は繰り返しリクエストを高速化するためにメモリにキャッシュされます。必要に応じてキャッシュをバイパスすることも可能です。
• 柔軟な構成: 環境変数を通じて接続の詳細と動作を設定できます。

前提条件

• Python 3.11以降。

StarRocks Official MCP Server

The StarRocks MCP Server acts as a bridge between AI assistants and StarRocks databases. It allows for direct SQL execution, database exploration, data visualization via charts, and retrieving detailed schema/data overviews without requiring complex client-side setup.

Features

• Direct SQL Execution: Run SELECT queries (read_query) and DDL/DML commands (write_query).
• Database Exploration: List databases and tables, retrieve table schemas (starrocks:// resources).
• System Information: Access internal StarRocks metrics and states via the proc:// resource path.
• Detailed Overviews: Get comprehensive summaries of tables (table_overview) or entire databases (db_overview), including column definitions, row counts, and sample data.
• Data Visualization: Execute a query and generate a Plotly chart directly from the results (query_and_plotly_chart).
• Intelligent Caching: Table and database overviews are cached in memory to speed up repeated requests. Cache can be bypassed when needed.
• Flexible Configuration: Set connection details and behavior via environment variables.

Prerequisites

• Python 3.11 or newer.
• A reachable StarRocks cluster (FE service). By default the server connects to localhost:9030 over the MySQL protocol.
• uv — a fast Python package and project manager (a modern replacement for pip + virtualenv) from Astral. This project uses uv to resolve dependencies, create the virtual environment, and launch the server. The uv run commands throughout this README automatically create an isolated environment and install the required dependencies on first use, so no manual pip install step is needed.

Installing uv

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Or via Homebrew / pipx / pip
brew install uv
# pipx install uv
# pip install uv

See the official uv installation guide for other options. After installing, verify it is on your PATH:

uv --version

Installation

You generally do not need to install the package manually — the MCP host launches it for you via uv (see Configuration below). uv fetches the package and its dependencies on demand.

To run it directly for testing or development:

# Run the published package in a throwaway environment