跳到內容
Framedash Docs

MCP Server

Framedash MCP Server 是一個 Model Context Protocol 伺服器，可讓 LLM 直接存取 Framedash 遙測資料。提供 12 個唯讀工具和 4 個資源，支援使用自然語言查詢遊戲分析資料。

設定

Section titled “設定”

Claude Desktop

Section titled “Claude Desktop”

在 claude_desktop_config.json 中新增：

{
  "mcpServers": {
    "framedash": {
      "command": "npx",
      "args": ["-y", "@framedash/mcp-server"],
      "env": {
        "FRAMEDASH_API_KEY": "fd_admin_xxx",
        "FRAMEDASH_PROJECT_ID": "your-project-uuid"
      }
    }
  }
}

VS Code (Claude Extension)

Section titled “VS Code (Claude Extension)”

在 VS Code 設定中新增：

{
  "claude.mcpServers": {
    "framedash": {
      "command": "npx",
      "args": ["-y", "@framedash/mcp-server"],
      "env": {
        "FRAMEDASH_API_KEY": "fd_admin_xxx",
        "FRAMEDASH_PROJECT_ID": "your-project-uuid"
      }
    }
  }
}

環境變數

Section titled “環境變數”
變數必須說明
FRAMEDASH_API_KEY是Admin API 金鑰（fd_admin_ 前綴）
FRAMEDASH_PROJECT_ID否預設專案 UUID
FRAMEDASH_BASE_URL否API 基礎 URL（預設：https://app.framedash.dev）

工具

Section titled “工具”

查詢

Section titled “查詢”
工具說明參數
query對 ClickHouse events 表執行唯讀 SQL 查詢sql (string, 必須), project_id (uuid, 選填), limit (int 1-1000, 預設 100)

分析

Section titled “分析”
工具說明參數
get_dashboard專案 KPI（DAU、MAU、工作階段、事件數）project_id (uuid, 選填), days (7/14/30/90, 預設 30)
get_retention同期群留存分析project_id (uuid, 選填), days (7/14/30/90, 預設 30)
get_funnel事件漏斗分析project_id (uuid, 選填), steps (string, 必須: 逗號分隔 2-8 個事件名), days (7/14/30/90, 預設 30)
get_insights按維度彙總的洞察project_id (uuid, 選填), metric (count/unique_players, 必須), group_by (string, 必須: event_name, platform 等), days (7/14/30/90, 預設 30), limit (10/20/50), event_name (string, 選填)
get_heatmap地圖的熱力圖網格資料project_id (uuid, 選填), map_id (string, 必須), cell_size (5/10/25/50, 預設 25), days (1/7/14/30, 預設 7), event_name (string, 選填)

專案

Section titled “專案”
工具說明參數
list_projects顯示 API 金鑰關聯的專案無
get_project_status專案健康概覽（事件數、最後事件時間）project_id (uuid, 選填)
list_maps專案中的地圖清單project_id (uuid, 選填)
list_content內容註冊表項目清單project_id (uuid, 選填), type (string, 選填)

告警

Section titled “告警”
工具說明參數
list_alerts告警規則清單project_id (uuid, 選填)
get_alert_history告警觸發/解除歷史project_id (uuid, 選填), limit (int 1-100, 預設 50)

資源

Section titled “資源”

透過 framedash:// URI 方案以 MCP 資源方式存取資料：

URI說明
framedash://projectsAPI 金鑰關聯的專案
framedash://projects/{projectId}/maps包含座標和範圍的地圖清單
framedash://projects/{projectId}/content內容註冊表項目
framedash://projects/{projectId}/status專案狀態和統計

使用範例

Section titled “使用範例”

設定 MCP Server 後，可以使用自然語言查詢資料：

範例提示使用的工具
”顯示過去 7 天的 DAU”get_dashboard (days=7)
“分析從 spawn 到 death 的漏斗”get_funnel (steps=“player.spawn,player.death”)
“按平台統計事件數”get_insights (metric=count, group_by=platform)
“顯示地圖的 FPS 熱力圖”get_heatmap (map_id=…)
”查看最近的告警歷史”get_alert_history

下一步

Section titled “下一步”