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