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-plugin
claude 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

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）

如果只需要 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。

其他编码代理

技能遵循开放的 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）。

面向 AI 代理: llms.txt