Starrocks MCP Server

🚀 StarRocks Official MCP Server

The StarRocks MCP server serves as a bridge between the AI assistant and the StarRocks database, allowing direct execution of SQL and database exploration without complex setup or configuration.

🚀 Quick Start

📦 Installation

The MCP server configuration is as follows:

{
  "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"
      }
    }
  }
}

If mcp-server-starrocks is not installed as a Python package (in a development environment), you can run it using 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 have 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}

  • System internal information exposed by StarRocks, similar to /proc in Linux.
  • Common paths include:
    • /frontends - Display information about FE nodes.
    • /backends - If it's a non-cloud-native deployment, display information about BE nodes.
    • /compute_nodes - If it's a cloud-native deployment, display information about CN nodes.
    • /dbs - Display information about databases.
    • /dbs/<DB_ID> - Display database information based on the database ID.
    • /dbs/<DB_ID>/<TABLE_ID> - Display table information based on the database and table ID.
    • /dbs/<DB_ID>/<TABLE_ID>/partitions - Display partition information based on the database and table ID.
    • /transactions - Display transaction information for each database.
    • /transactions/<DB_ID> - Display transaction information based on the database ID.
    • /transactions/<DB_ID>/running - Display information about running transactions based on the database ID.
    • /transactions/<DB_ID>/finished - Display information about finished transactions based on the database ID.
    • /jobs - Display information about all workflows.
    • /statistic - Display statistical information for each database.
    • /tasks - Display all general tasks and the number of failed tasks.
    • /cluster_balance - Display cluster load balancing information.
    • /routine_loads - Display information about routine loads.
    • /colocation_group - Display information about colocate join groups.
    • /catalog - Display information about the catalog.