F

framedash-mcp-server

framedash-mcp-server

本地服务

framedash.dev数据与分析06 天前更新

代码仓库访问官网

关于 framedash-mcp-server

framedash-mcp-server 将 LLM 工具连接到 Framedash 游戏遥测分析平台。它提供只读查询，可查看指标、留存、漏斗、热图、项目健康状态和告警。

主要功能

01执行 SQL SELECT 分析查询
02查看仪表板 KPI 汇总
03分析留存和事件漏斗
04获取地图热图数据
05查看项目健康状态和告警历史

适用场景

01查看玩家活动指标
02分析留存队列和事件漏斗
03检查地图热图及项目告警

MCP 相关

该 MCP 服务提供 12 个只读工具和 4 个资源，用于查询 Framedash 分析数据。访问需使用 Framedash API 密钥，并可限定到指定项目。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "crane-valley-framedash": {
      "command": "npx",
      "args": [
        "-y",
        "@framedash/mcp-server"
      ],
      "env": {
        "FRAMEDASH_API_KEY": "<FRAMEDASH_API_KEY>",
        "FRAMEDASH_PROJECT_ID": "<FRAMEDASH_PROJECT_ID>",
        "FRAMEDASH_BASE_URL": "<FRAMEDASH_BASE_URL>"
      }
    }
  }
}

启动命令npx -y @framedash/mcp-server

需要配置的环境变量

FRAMEDASH_API_KEY密钥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.

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npm@framedash/mcp-server0.1.5stdio

工具

12

收录的工具列表 · 更新于 2 周前

参数	类型	必填	说明
sql	string	是	要执行的 SQL 查询
limit	integer	否	返回的最大行数（默认值：100）
project_id	string	否	覆盖默认 project ID

详细介绍

@framedash/mcp-server

适用于 Framedash 游戏遥测平台的 MCP（Model Context Protocol）服务。提供 12 个只读工具和 4 个资源，供由大模型驱动的工具查询分析数据。

设置

Claude Desktop

添加到你的 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）

添加到你的 VS Code 设置中：

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

环境变量

变量	必填	描述
`FRAMEDASH_API_KEY`	是	用于聚合工具、具有 `analytics:read` 权限的 API 密钥；原始 `query` 工具还需要 `data:admin` 权限
`FRAMEDASH_PROJECT_ID`	否	项目级工具使用的默认项目 UUID
`FRAMEDASH_BASE_URL`	否	API 基础 URL（默认值：`https://app.framedash.dev`）

如果省略 FRAMEDASH_PROJECT_ID，项目级工具仍可使用，但每次调用都必须显式提供 project_id 参数。

工具

工具	描述
`query`	执行 SQL 分析查询（仅限 SELECT，默认上限为 100）
`get_dashboard`	项目 KPI 摘要（DAU、MAU、会话、事件）
`get_retention`	Cohort 留存数据
`get_funnel`	对事件步骤进行漏斗分析
`get_insights`	按分组查看事件洞察
`get_heatmap`	地图的热力图网格数据
`list_projects`	显示与 API 密钥绑定的项目
`get_project_status`	项目健康状况概览
`list_maps`	列出项目中的地图
`list_content`	列出内容注册表条目
`list_alerts`	列出告警规则
`get_alert_history`	告警触发历史记录

资源

URI	描述
`framedash://projects`	与 API 密钥绑定的项目
`framedash://projects/{projectId}/maps`	含边界信息的地图列表
`framedash://projects/{projectId}/content`	内容注册表
`framedash://projects/{projectId}/status`	项目健康状态

开发

从仓库根目录运行：

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

使用 pnpm 9 时，末尾的 ... 会选择 MCP 包及其工作区依赖项（包括 @framedash/api-client），然后从干净的检出状态开始编译。

许可证

MIT

评论

支持 Markdown

登录后评论

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

阅读入门指南

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。