io.github.crane-valley/framedash-mcp-server
MCP server for Framedash game telemetry: query analytics, heatmaps, perf regressions, and alerts
Install
Add this to your client's MCP configuration (Claude Desktop: claude_desktop_config.json; Cursor: .cursor/mcp.json; VS Code and others use the same "mcpServers" shape).
@framedash/mcp-serverclaude mcp add framedash-mcp-server -e 'FRAMEDASH_API_KEY=<your framedash_api_key>' -e 'FRAMEDASH_PROJECT_ID=<FRAMEDASH_PROJECT_ID>' -e 'FRAMEDASH_BASE_URL=<FRAMEDASH_BASE_URL>' -- npx -y @framedash/mcp-server@0.1.5
{
"mcpServers": {
"framedash-mcp-server": {
"command": "npx",
"args": [
"-y",
"@framedash/mcp-server@0.1.5"
],
"env": {
"FRAMEDASH_API_KEY": "<your framedash_api_key>",
"FRAMEDASH_PROJECT_ID": "<FRAMEDASH_PROJECT_ID>",
"FRAMEDASH_BASE_URL": "<FRAMEDASH_BASE_URL>"
}
}
}
}
Environment variables
FRAMEDASH_API_KEYrequired secret Framedash API key. Create one on your project's API Keys page at https://app.framedash.dev.FRAMEDASH_PROJECT_IDDefault project id. When unset, project-scoped tools require a project_id argument.FRAMEDASH_BASE_URLAPI base URL. Defaults to https://app.framedash.dev.
Documentation
From the project's README on GitHub, refreshed weekly. Links open on GitHub.
@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
| Variable | Required | Description |
|---|---|---|
FRAMEDASH_API_KEY | Yes | API key with analytics:read for the aggregate tools; the raw query tool additionally requires data:admin |
FRAMEDASH_PROJECT_ID | No | Default project UUID for project-scoped tools |
FRAMEDASH_BASE_URL | No | API 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
| Tool | Description |
|---|---|
query | Execute SQL analytics query (SELECT only, limit default 100) |
get_dashboard | Project KPI summary (DAU, MAU, sessions, events) |
get_retention | Cohort retention data |
get_funnel | Funnel analysis for event steps |
get_insights | Event insights with grouping |
get_heatmap | Heatmap grid data for a map |
list_projects | Show the project bound to the API key |
get_project_status | Project health overview |
list_maps | List maps in a project |
list_content | List content registry entries |
list_alerts | List alert rules |
get_alert_history | Alert trigger history |
Resources
| URI | Description |
|---|---|
framedash://projects | Project bound to the API key |
framedash://projects/{projectId}/maps | Map list with bounds |
framedash://projects/{projectId}/content | Content registry |
framedash://projects/{projectId}/status | Project 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
Frequently asked questions
What is io.github.crane-valley/framedash-mcp-server?
MCP server for Framedash game telemetry: query analytics, heatmaps, perf regressions, and alerts
How do I install io.github.crane-valley/framedash-mcp-server?
It runs on your machine. In Claude Code: claude mcp add framedash-mcp-server -e 'FRAMEDASH_API_KEY=<your framedash_api_key>' -e 'FRAMEDASH_PROJECT_ID=<FRAMEDASH_PROJECT_ID>' -e 'FRAMEDASH_BASE_URL=<FRAMEDASH_BASE_URL>' -- npx -y @framedash/mcp-server@0.1.5. For other clients, paste the JSON configuration from this page into their MCP settings.
Does io.github.crane-valley/framedash-mcp-server need an API key?
Yes. It expects FRAMEDASH_API_KEY, which you set in its configuration.
Is io.github.crane-valley/framedash-mcp-server open source?
Yes. Its code is on GitHub under the MIT license.
Who maintains io.github.crane-valley/framedash-mcp-server?
It is published by crane-valley. AI.tn lists it but does not maintain or endorse it.
From the official MCP Registry. Listing is not an endorsement: review a server's code and permissions before giving it access to your data.