Claude Code Plugin
Claude Code 版 Framedash 外掛將從 Claude Code 查詢遊戲遙測資料所需的一切打包在一起:Framedash MCP Server、技能(CLI 使用模式、針對 events 結構的 SQL 查詢手冊、perf-diff CI 配方、Unity/UE5/Godot 整合指南),以及用於引導式設定的 /framedash:setup 指令。
新增市集,然後安裝外掛:
claude plugin marketplace add crane-valley/framedash-claude-pluginclaude plugin install framedash@framedash如果你已安裝舊版本,上面兩條指令都會回報「已安裝」並結束,不會更新它。要升級到最新版本,請執行 update(需要重新啟動 Claude Code 才會生效):
claude plugin update framedash@framedash用 list 確認已安裝的版本:
claude plugin list可在儀表板中你的專案「API 金鑰」頁面建立 API 金鑰(參見 API 概覽)。在啟動 Claude Code 之前,於 shell 中設定 API 金鑰。請勿將金鑰貼到聊天中。
export FRAMEDASH_API_KEY="fd_xxx"export FRAMEDASH_PROJECT_ID="your-project-uuid" # 選填在 Windows PowerShell 上:
$env:FRAMEDASH_API_KEY="fd_xxx"$env:FRAMEDASH_PROJECT_ID="your-project-uuid" # 選填接著在 Claude Code 中執行引導式設定指令:
/framedash:setup要驗證設定,執行 /framedash:setup,或呼叫一個讀取工具(例如「給我看最近 7 天的 DAU」)並確認有資料回傳。
| 變數 | 必填 | 說明 |
|---|---|---|
FRAMEDASH_API_KEY | 是 | 具有所用工具所需 scope 的 API 金鑰(參見下方 scope 清單)。 |
FRAMEDASH_PROJECT_ID | 否 | 預設專案 UUID。 |
FRAMEDASH_BASE_URL | 否 | API 基礎 URL(預設:https://app.framedash.dev)。 |
API 金鑰 scope
Section titled “API 金鑰 scope”| scope | 授予的權限 |
|---|---|
analytics:read | 唯讀工具(儀表板、留存、漏斗、洞察、熱力圖、清單)。 |
data:admin | 在 analytics:read 之外,額外授予 raw SQL query 工具。 |
resources:write | 建立/更新/刪除警示、刪除地圖、匯入內容。 |
- MCP Server — Framedash MCP Server 宣告(stdio,
npx -y @framedash/mcp-server)。 - 技能 — CLI 使用模式、針對 events 結構的 SQL 查詢手冊、perf-diff CI 配方、Unity/UE5/Godot 整合指南。
- 指令 — 用於引導式設定的
/framedash:setup。
不使用外掛(raw MCP)
Section titled “不使用外掛(raw MCP)”如果只需要 MCP 工具,可直接註冊伺服器:
claude mcp add framedash \ -e FRAMEDASH_API_KEY=fd_xxx \ -e FRAMEDASH_PROJECT_ID=your-project-uuid \ -- npx -y @framedash/mcp-server在 Windows PowerShell 上,請使用直引號並寫在一行(不使用行末反斜線):
claude mcp add framedash -e FRAMEDASH_API_KEY=fd_xxx -e FRAMEDASH_PROJECT_ID=your-project-uuid -- npx -y @framedash/mcp-server完整的工具和資源參考請見 MCP Server。
其他程式設計代理
Section titled “其他程式設計代理”技能遵循開放的 Agent Skills 規範(SKILL.md),因此可在任何使用技能的代理中運作,而 MCP Server 宣告可在任何 MCP 用戶端中使用。若要在 Claude Code 之外(例如 Codex CLI)使用相同的功能,請讓代理指向外掛的 SKILL.md 檔案或 @framedash/mcp-server 套件。
- MCP Server:完整的工具和資源參考。
- CLI 參考:命令列工具。
儲存庫:crane-valley/framedash-claude-plugin(v0.2.3,MIT)。