Back to Directory/Analytics & BI

io.github.crane-valley/framedash-mcp-server

MCP server for Framedash game telemetry: query analytics, heatmaps, perf regressions, and alerts

Analytics & BITypeScriptv0.1.5

@framedash/mcp-server

MCP (Model Context Protocol) server for the Framedash game telemetry platform. Provides 12 read-only tools and 4 resources for querying analytics data from LLM-powered tools.

Setup

Claude Desktop

Add to your claude_desktop_config.json:

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

VS Code (Claude Extension)

Add to your VS Code settings:

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

Environment Variables

VariableRequiredDescription
FRAMEDASH_API_KEYYesAPI key with analytics:read for the aggregate tools; the raw query tool additionally requires data:admin
FRAMEDASH_PROJECT_IDNoDefault project UUID for project-scoped tools
FRAMEDASH_BASE_URLNoAPI base URL (default: https://app.framedash.dev)

If FRAMEDASH_PROJECT_ID is omitted, project-scoped tools still work but require an explicit project_id argument per call.

Tools

ToolDescription
queryExecute SQL analytics query (SELECT only, limit default 100)
get_dashboardProject KPI summary (DAU, MAU, sessions, events)
get_retentionCohort retention data
get_funnelFunnel analysis for event steps
get_insightsEvent insights with grouping
get_heatmapHeatmap grid data for a map
list_projectsShow the project bound to the API key
get_project_statusProject health overview
list_mapsList maps in a project
list_contentList content registry entries
list_alertsList alert rules
get_alert_historyAlert trigger history

Resources

URIDescription
framedash://projectsProject bound to the API key
framedash://projects/{projectId}/mapsMap list with bounds
framedash://projects/{projectId}/contentContent registry
framedash://projects/{projectId}/statusProject health status

Development

Run from the repository root:

pnpm install
pnpm --filter @framedash/mcp-server... build
pnpm --filter @framedash/mcp-server test

With pnpm 9, the trailing ... selects the MCP package plus its workspace dependencies, including @framedash/api-client, before compiling from a clean checkout.

License

MIT

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
npx -y @framedash/mcp-server

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "io-github-crane-valley-framedash-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@framedash/mcp-server"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

@framedash/mcp-servernpm

Compatible MCP Clients

io.github.crane-valley/framedash-mcp-server works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More