StarRocks MCP Server служит мостом между AI-ассистентами и базами данных StarRocks. Он обеспечивает прямое выполнение SQL, исследование баз данных, визуализацию данных с помощью диаграмм и получение подробных схем/обзоров данных без необходимости сложной настройки на стороне клиента.

Особенности

• Прямое исполнение SQL: Выполнять запросы SELECT (read_query) и команды DDL/DML (write_query).
• Исследование баз данных: Список баз данных и таблиц, поиск схем таблиц (starrocks:// ресурсов).
• Информация о системе: Доступ к внутренним метрикам и состояниям StarRocks через путь ресурсов proc://.
• Подробные обзоры: Получите подробные сводки таблиц ([[T5]) или целых баз данных (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