Claude Code Plugin
The Framedash plugin for Claude Code bundles everything you need to query your game telemetry from Claude Code: the Framedash MCP server, skills (CLI usage patterns, a SQL query cookbook over the events schema, perf-diff CI recipes, and Unity, UE5, and Godot integration guides), and a /framedash:setup command for guided configuration.
Install
Section titled “Install”Add the marketplace, then install the plugin:
claude plugin marketplace add crane-valley/framedash-claude-pluginclaude plugin install framedash@framedashIf you already have an older version installed, both commands above exit reporting “already installed” and do not update it. To move to the latest version, run update (a restart is required to apply it):
claude plugin update framedash@framedashConfirm the installed version with list:
claude plugin listConfigure
Section titled “Configure”Create an API key from your project’s “API Keys” page in the dashboard (see the API Overview). Set your API key in the shell before starting Claude Code. Never paste keys into chat.
export FRAMEDASH_API_KEY="fd_xxx"export FRAMEDASH_PROJECT_ID="your-project-uuid" # optionalOn Windows PowerShell:
$env:FRAMEDASH_API_KEY="fd_xxx"$env:FRAMEDASH_PROJECT_ID="your-project-uuid" # optionalThen run the guided setup command inside Claude Code:
/framedash:setupTo verify the setup, run /framedash:setup or call a read tool (for example, “Show me DAU for the last 7 days”) and confirm that data comes back.
Environment Variables
Section titled “Environment Variables”| Variable | Required | Description |
|---|---|---|
FRAMEDASH_API_KEY | Yes | API key scoped to the tools you use (see scopes below). |
FRAMEDASH_PROJECT_ID | No | Default project UUID. |
FRAMEDASH_BASE_URL | No | API base URL (default: https://app.framedash.dev). |
API Key Scopes
Section titled “API Key Scopes”| Scope | Grants |
|---|---|
analytics:read | Read tools (dashboards, retention, funnels, insights, heatmaps, lists). |
data:admin | The raw SQL query tool, in addition to analytics:read. |
resources:write | Create/update/delete alerts, delete maps, and import content. |
What’s Included
Section titled “What’s Included”- MCP server — the Framedash MCP server declaration (stdio,
npx -y @framedash/mcp-server). - Skills — CLI usage patterns, a SQL query cookbook over the events schema, perf-diff CI recipes, and Unity, UE5, and Godot integration guides.
- Command —
/framedash:setupfor guided configuration.
Without the Plugin (Raw MCP)
Section titled “Without the Plugin (Raw MCP)”If you only need the MCP tools, register the server directly:
claude mcp add framedash \ -e FRAMEDASH_API_KEY=fd_xxx \ -e FRAMEDASH_PROJECT_ID=your-project-uuid \ -- npx -y @framedash/mcp-serverOn Windows PowerShell, use straight quotes and no backslash line breaks:
claude mcp add framedash -e FRAMEDASH_API_KEY=fd_xxx -e FRAMEDASH_PROJECT_ID=your-project-uuid -- npx -y @framedash/mcp-serverSee MCP Server for the full tool and resource reference.
Other Coding Agents
Section titled “Other Coding Agents”The skills follow the open Agent Skills spec (SKILL.md), so they work in any agent that consumes skills, and the MCP server declaration works in any MCP client. Point your agent at the plugin’s SKILL.md files or the @framedash/mcp-server package to use the same capabilities outside Claude Code (for example, Codex CLI).
Next Steps
Section titled “Next Steps”- MCP Server: full tool and resource reference.
- CLI Reference: command-line tool.
Repository: crane-valley/framedash-claude-plugin (v0.2.3, MIT).