MCP Server Starrocks

🚀 MCP Server Configuration and Components

This document provides detailed information about the configuration and components of the MCP server, including server configuration examples and descriptions of various tools and resources.

🚀 Quick Start

Configuration

The following is the configuration example for the MCP server:

Installed as a Python Package

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "mcp-server-starrocks",
        "mcp-server-starrocks"
      ],
      "env": {
        "STARROCKS_HOST": "Default: localhost",
        "STARROCKS_PORT": "Default: 9030",
        "STARROCKS_USER": "Default: root",
        "STARROCKS_PASSWORD": "Default: empty"
      }
    }
  }
}

Run from Local Directory (Development Environment)

If mcp-server-starrocks is not installed as a Python package, you can run it from a local directory:

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/mcp-server-starrocks",
        "run",
        "mcp-server-starrocks"
      ],
      "env": {
        "STARROCKS_HOST": "Default: localhost",
        "STARROCKS_PORT": "Default: 9030",
        "STARROCKS_USER": "Default: root",
        "STARROCKS_PASSWORD": "Default: empty"
      }
    }
  }
}

✨ Features

Tools

• read_query:
  • Execute a SELECT query or a command that returns a ResultSet.
• write_query:
  • Execute DDL/DML or other StarRocks commands that do not return a ResultSet.

Resources

Direct Resources

• starrocks:///databases:
  • List all databases in StarRocks.

Resource Templates

• starrocks:///{db}/{table}/schema:
  • Get the schema information of a table using SHOW CREATE TABLE.
• starrocks:///{db}/tables:
  • List all tables in a specific database.
• proc:///{+path}:
  • Internal information of the StarRocks system, similar to Linux's /proc.
  • Common paths include:
    • /frontends: Display information about FE nodes.
    • /backends: Display information about BE nodes (for non-cloud-native deployments).
    • /compute_nodes: Display information about CN nodes (for cloud-native deployments).
    • /dbs: Display database information.
    • /dbs/<DB_ID>: Display database information by database ID.
    • /dbs/<DB_ID>/<TABLE_ID>: Display table information by database ID and table ID.
    • /dbs/<DB_ID>/<TABLE_ID>/partitions: Display partition information by database ID and table ID.
    • /transactions: Display transaction information by database.
    • /transactions/<DB_ID>: Display transaction information by database ID.
    • /transactions/<DB_ID>/running: Display information about running transactions by database ID.
    • /transactions/<DB_ID>/finished: Display information about finished transactions by database ID.
    • /jobs: Display job information.
    • /statistic: Display statistical information for each database.
    • /tasks: Display the total number of all general tasks and failed tasks.
    • /cluster_balance: Display cluster load balancing information.
    • /routine_loads: Display Routine Load information.
    • /colocation_group: Display information about Colocate Join groups.
    • /catalog: Display catalog information.