Starrocks MCP Server Starrocks

🚀 StarRocks 官方 MCP 服務器

StarRocks MCP Server 作為 AI 助手與 StarRocks 數據庫之間的橋樑，支持直接執行 SQL 語句和進行數據庫探索，無需進行復雜的設置或配置。

🚀 快速開始

配置

MCP 服務器配置如下：

{
  "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": "默認空"
      }
    }
  }
}

如果 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：顯示目錄信息。

提示語

無