Starrocks MCP Server Starrocks

🚀 StarRocks Official MCP Server

The StarRocks MCP Server serves as a bridge between AI assistants and the StarRocks database, supporting direct SQL execution and database exploration without complex setup or configuration.

🚀 Quick Start

✨ Features

• Acts as a bridge between AI assistants and StarRocks databases.
• Enables direct SQL execution and database exploration.
• Eliminates the need for complex setup or configuration.

📦 Installation

Configuration

The configuration of the MCP server 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"
      }
    }
  }
}

📚 Documentation

Components

Tools

• read_query
  • Execute SELECT queries or other commands that return 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
  • Use SHOW CREATE TABLE to get the schema information of a table.
• starrocks:///{db}/tables
  • List all tables in a specific database.
• proc:///{+path}
  • System internal information exposed by StarRocks, similar to the /proc directory in Linux.
  • Common paths include:
    • /frontends - Show information about FE nodes.
    • /backends - Show information about BE nodes (only applicable to non-cloud-native deployments).
    • /compute_nodes - Show information about CN nodes (applicable to cloud-native deployments).
    • /dbs - Show database information.
    • /dbs/<DB_ID> - Show information about a specific database based on the database ID.
    • /dbs/<DB_ID>/<TABLE_ID> - Show information about a table based on the database ID and table ID.
    • /dbs/<DB_ID>/<TABLE_ID>/partitions - Show partition information based on the database ID and table ID.
    • /transactions - Show transaction information categorized by database.
    • /transactions/<DB_ID> - Show transaction information based on the database ID.
    • /transactions/<DB_ID>/running - Show information about running transactions based on the database ID.
    • /transactions/<DB_ID>/finished - Show information about completed transactions based on the database ID.
    • /jobs - Show all general tasks and the total number of failed tasks.
    • /statistic - Show statistical information for each database.
    • /tasks - Show all regular tasks and the total number of failed tasks.
    • /cluster_balance - Show load balancing information.
    • /routine_loads - Show Routine Load information.
    • /colocation_group - Show information about Colocate Join groups.
    • /catalog - Show catalog information.

Prompts

No prompts are provided.