Skip to main content

official MCP server for StarRocks

Project description

Starrocks Official MCP server

The StarRocks MCP Server acts as a bridge between AI assistants and StarRocks databases, allowing for direct SQL execution and database exploration without requiring complex setup or configuration.

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

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

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

mseep_mcp_server_starrocks-0.1.0.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

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

mseep_mcp_server_starrocks-0.1.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mseep_mcp_server_starrocks-0.1.0.tar.gz
Algorithm Hash digest
SHA256 44caaa40e4c3f3006fd41f2818aa571ce3835f230e44dd429aa3102a7d6a58dd
MD5 1897128f2150e162db07684f2889416d
BLAKE2b-256 f141d26b50808e8656121d7dcae8df75526fc1ece9ab83e008c55fc4a0cb8a49

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mseep_mcp_server_starrocks-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb616f3a33ce13b4a04524800dc168bf42aa0b7feb05b162ce455f2a99f3786a
MD5 d7acc83ed8ccbbc577c05ac4bd0f68c5
BLAKE2b-256 c35365f61c1a51e7197f2450ce543c46418498ef66fd599554a601e47127d76f

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