Starrocks MCP Server Starrocks

🚀 StarRocks 官方 MCP 服务器

StarRocks MCP Server 作为 AI 助手与 StarRocks 数据库之间的桥梁，支持直接执行 SQL 语句和进行数据库探索，无需进行复杂的设置或配置。

🚀 快速开始

StarRocks MCP Server 配置主要分为两种情况：已安装为 Python 包和未安装为 Python 包（开发环境）。以下是详细配置说明：

已安装为 Python 包

若 mcp-server-starrocks 已安装为 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 包（开发环境）

若 mcp-server-starrocks 未安装为 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 或其他 StarRocks 命令，这些命令不会返回 ResultSet。

资源

直接资源

• starrocks:///databases：可列出 StarRocks 中的所有数据库。

资源模板

• starrocks:///{db}/{table}/schema：使用 SHOW CREATE TABLE 语句获取表的架构信息。
• starrocks:///{db}/tables：列出特定数据库中的所有表格。
• proc:///{+path}：StarRocks 暴露的系统内部信息，类似于 Linux 的 /proc 目录。常见路径及用途如下：
  • /frontends：显示 FE 节点的信息。
  • /backends：显示 BE 节点的信息（仅适用于非云原生部署）。
  • /compute_nodes：显示 CN 节点的信息（适用于云原生部署）。
  • /dbs：显示数据库信息。
  • /dbs/<DB_ID>：根据数据库 ID 显示特定数据库的信息。
  • /dbs/<DB_ID>/<TABLE_ID>：根据数据库 ID 和表格 ID 显示表格信息。
  • /dbs/<DB_ID>/<TABLE_ID>/partitions：根据数据库 ID 和表格 ID 显示分区信息。
  • /transactions：显示按数据库分类的事务信息。
  • /transactions/<DB_ID>：根据数据库 ID 显示事务信息。
  • /transactions/<DB_ID>/running：根据数据库 ID 显示正在运行的事务信息。
  • /transactions/<DB_ID>/finished：根据数据库 ID 显示已完成的事务信息。
  • /jobs：显示所有通用任务及其失败任务的总数。
  • /statistic：显示每个数据库的统计信息。
  • /tasks：显示所有常规任务及其失败任务的总数。
  • /cluster_balance：显示负载均衡信息。
  • /routine_loads：显示 Routine Load 信息。
  • /colocation_group：显示 Colocate Join 组的信息。
  • /catalog：显示目录信息。

提示语

无