English Français العربية

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

السجل الرسمي التسويق والمبيعات

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

الشيفرة المصدرية الموقع التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package @framedash/mcp-server
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
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "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>"
            }
        }
    }
}

متغيرات البيئة

  • FRAMEDASH_API_KEY إلزامي سري Framedash API key. Create one on your project's API Keys page at https://app.framedash.dev.
  • FRAMEDASH_PROJECT_ID Default project id. When unset, project-scoped tools require a project_id argument.
  • FRAMEDASH_BASE_URL API base URL. Defaults to https://app.framedash.dev.

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. @framedash/mcp-server
  2. Setup
  3. Environment Variables
  4. Tools
  5. Resources
  6. Development
  7. License

@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

الأسئلة الشائعة

ما هو io.github.crane-valley/framedash-mcp-server؟

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

كيف أثبّت io.github.crane-valley/framedash-mcp-server؟

يعمل على جهازك. في 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. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.crane-valley/framedash-mcp-server إلى مفتاح API؟

نعم. يتطلب FRAMEDASH_API_KEY، وتضبطها في إعداداته.

هل io.github.crane-valley/framedash-mcp-server مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.crane-valley/framedash-mcp-server؟

ينشره crane-valley. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.