Skip to main content

official MCP server for StarRocks

Project description

Starrocks Official MCP server

Components

Tools

  • read_query

    • Execute a SELECT query or commands that return a ResultSet
  • write_query

    • Execute an DDL/DML or other StarRocks command that do not have a ResultSet

Configuration

MCP server config

{
  "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 python package(in dev env), can run using local dir

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

Resources

Direct Resources

  • starrocks:///databases
    • Lists all databases in StarRocks

Resource Templates

  • starrocks:///{db}/{table}/schema

    • Gets the schema of a table using SHOW CREATE TABLE
  • starrocks:///{db}/tables

    • Lists all tables in a specific database
  • proc:///{+path}

    • System internal information exposed by StarRocks similar to linux /proc
    • Common paths include:
      • /frontends - Shows the information of FE nodes
      • /backends - Shows the information of BE nodes if this SR is non cloud native deployment
      • /compute_nodes - Shows the information of CN nodes if this SR is cloud native deployment
      • /dbs - Shows the information of databases
      • /dbs/<DB_ID> - Shows the information of a database by database ID
      • /dbs/<DB_ID>/<TABLE_ID> - Shows the information of tables by database ID
      • /dbs/<DB_ID>/<TABLE_ID>/partitions - Shows the information of partitions by database ID and table ID
      • /transactions - Shows the information of transactions by database
      • /transactions/<DB_ID> - Shows the information of transactions by database ID
      • /transactions/<DB_ID>/running - Shows the information of running transactions by database ID
      • /transactions/<DB_ID>/finished - Shows the information of finished transactions by database ID
      • /jobs - Shows the information of jobs
      • /statistic - Shows the statistics of each database
      • /tasks - Shows the total number of all generic tasks and the failed tasks
      • /cluster_balance - Shows the load balance information
      • /routine_loads - Shows the information of Routine Load
      • /colocation_group - Shows the information of Colocate Join groups
      • /catalog - Shows the information of catalogs

Prompts

None

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_starrocks-0.1.0.tar.gz (780.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_starrocks-0.1.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_starrocks-0.1.0.tar.gz.

File metadata

File hashes

Hashes for mcp_server_starrocks-0.1.0.tar.gz
Algorithm Hash digest
SHA256 12ce2a5d4312d22b2053ed6e9a3d2a329040435c0325a072b185e54c916576d3
MD5 ce72aa2796ed6a0c87cf2fe39190e683
BLAKE2b-256 bdfd21e5a36f26f5960ce4a631b5f41a818dd5fca57e18c31e877199489b85b4

See more details on using hashes here.

File details

Details for the file mcp_server_starrocks-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_starrocks-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2b993d27f5bb4dc93daa49af7f8af7c7a92c392f893a0ee79c03475a2d25c46
MD5 8b41f3afeb41c90918db97a3408b6d8c
BLAKE2b-256 3dce46a570dcfc926d25ce20c1adfac25cf1a8b03df652de3e124d091b42111a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page