StarRocks MCP Server

🚀 星辰 rocks 官方 MCP 服务器

星辰 rocks MCP 服务器作为 AI 助手与星辰 rocks 数据库之间的桥梁，让用户无需进行复杂的设置或配置，即可直接执行 SQL 语句并探索数据库。

🚀 快速开始

📦 安装指南

本部分文档未提及安装步骤，若有相关需求，请参考官方文档或后续补充内容。

🔧 配置

以下是 MCP 服务器的配置示例：

作为 Python 包安装时的配置

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

未作为 Python 包安装（开发环境）时的配置

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

✨ 主要特性

组件

工具

• read_query：执行 SELECT 查询或返回 ResultSet 的命令。
• write_query：执行 DDL/DML 或其他星辰 rocks 命令，这些命令没有 ResultSet。

资源

直接资源

• starrocks:///databases：列出星辰 rocks 中的所有数据库。

资源模板

• starrocks:///{db}/{table}/schema：使用 SHOW CREATE TABLE 获取表的架构信息。
• starrocks:///{db}/tables：在特定数据库中列出所有表。
• proc:///{+path}：星辰 rocks 暴露的系统内部信息，类似于 linux /proc。常见路径包括：
  • /frontends：显示 FE 节点的信息。
  • /backends：如果是非云原生部署，显示 BE 节点的信息。
  • /compute_nodes：如果是云原生部署，显示 CN 节点的信息。
  • /dbs：显示数据库的信息。
  • /dbs/<DB_ID>：根据数据库 ID 显示数据库信息。
  • /dbs/<DB_ID>/<TABLE_ID>：根据数据库和表 ID 显示表信息。
  • /dbs/<DB_ID>/<TABLE_ID>/partitions：根据数据库和表 ID 显示分区信息。
  • /transactions：显示每个数据库的事务信息。
  • /transactions/<DB_ID>：根据数据库 ID 显示事务信息。
  • /transactions/<DB_ID>/running：根据数据库 ID 显示正在运行的事务信息。
  • /transactions/<DB_ID>/finished：根据数据库 ID 显示已完成的事务信息。
  • /jobs：显示所有工作流的信息。
  • /statistic：显示每个数据库的统计信息。
  • /tasks：显示所有通用任务及其失败任务的数量。
  • /cluster_balance：显示集群负载均衡信息。
  • /routine_loads：显示常规加载信息。
  • /colocation_group：显示 colocate join 组的信息。
  • /catalog：显示目录的信息。