MCP Server Starrocks

🚀 MCP 服务器项目

本项目主要围绕 MCP 服务器展开，提供了服务器的配置方法以及相关组件的使用说明，帮助用户更好地使用和管理 MCP 服务器与 StarRocks 数据库。

🚀 快速开始

配置

MCP 服务器配置分为两种情况，一种是 mcp-server-starrocks 已安装为 Python 包的情况，另一种是在开发环境中未安装为 Python 包，使用本地目录运行的情况。

已安装为 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": "默认 空"
      }
    }
  }
}

开发环境使用本地目录运行的配置

{
  "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}：星罗系统内部信息，类似于 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：显示目录信息。