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