Set up Framedash with Claude Code, Codex, or any MCP client in 5 minutes

This is the fastest way to let an AI coding agent read your Framedash telemetry and gate your CI. Pick the path that matches your agent: the Claude Code plugin, a raw MCP registration for any MCP client, or an AGENTS.md snippet for repo-aware agents. All three use the same @framedash/mcp-server package and a FRAMEDASH_API_KEY.

Before you start

Create an API key in the dashboard and export it in your shell. Never paste keys into chat.

export FRAMEDASH_API_KEY="fd_xxx"
export FRAMEDASH_PROJECT_ID="your-project-uuid"  # optional

Use a Read-only key for the analytics tools, or a Full key if you want the raw SQL query tool as well.

Path A: Claude Code plugin

The plugin bundles the MCP server, skills for the CLI and SQL query patterns, Unity, UE5, and Godot integration guides, and a /framedash:setup command. Add the marketplace and install:

claude plugin marketplace add crane-valley/framedash-claude-plugin
claude plugin install framedash@framedash

Then run /framedash:setup inside Claude Code for guided configuration. See the Claude Code plugin guide for the full contents.

Path B: Raw MCP server, any client

If you only need the MCP tools, register the stdio server directly. In Claude Code:

claude mcp add framedash \
  -e FRAMEDASH_API_KEY=fd_xxx \
  -e FRAMEDASH_PROJECT_ID=your-project-uuid \
  -- npx -y @framedash/mcp-server

Other MCP clients accept the same npx -y @framedash/mcp-server command in their own config. Codex CLI registers it through codex mcp add or config.toml; see Codex CLI. The server exposes 12 read-only tools (dashboards, retention, funnels, insights, heatmaps, project and alert listings, and raw SQL with a Full key) and 4 resources. The full list is in the MCP server reference.

Clients that support remote MCP servers and OAuth can skip the local install and use the hosted endpoint at https://app.framedash.dev/api/mcp instead.

Path C: AGENTS.md snippet

For a repo-aware agent, drop a Framedash block into your AGENTS.md (Codex and others) or CLAUDE.md (Claude Code). It points the agent at the docs, the CLI, the MCP server, and the environment variables in one place. Copy it from the AGENTS.md snippet.

Gate CI from an agent

The same key drives the CLI, so an agent can wire up a performance gate. Install @framedash/cli, then fail a build when a candidate regresses beyond a threshold:

npm install -g @framedash/cli

framedash perf-diff --baseline "$BASE_SHA" --candidate "$GITHUB_SHA" \
  --threshold 5 --fail-on-regression

For the end-to-end profiling gate, see CI-integrated profiling.

Next steps

• MCP server reference: every tool, resource, and the hosted endpoint
• Claude Code plugin: skills, scopes, and setup
• CLI reference: commands for CI and local queries