콘텐츠로 이동
Framedash Docs

MCP Server

Framedash MCP Server는 LLM이 Framedash 텔레메트리 데이터에 직접 접근할 수 있도록 하는 Model Context Protocol 서버입니다. 12개의 읽기 전용 도구와 4개의 리소스를 제공하며, 자연어로 게임 분석 데이터를 조회할 수 있습니다.

설정

섹션 제목: “설정”

Claude Desktop

섹션 제목: “Claude Desktop”

claude_desktop_config.json에 다음을 추가합니다:

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

VS Code (Claude Extension)

섹션 제목: “VS Code (Claude Extension)”

VS Code 설정에 다음을 추가합니다:

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

환경 변수

섹션 제목: “환경 변수”
변수필수설명
FRAMEDASH_API_KEY예Admin API 키 (fd_admin_ 접두사)
FRAMEDASH_PROJECT_ID아니오기본 프로젝트 UUID
FRAMEDASH_BASE_URL아니오API 기본 URL (기본값: https://app.framedash.dev)

도구

섹션 제목: “도구”

쿼리

섹션 제목: “쿼리”
도구설명인수
queryClickHouse events 테이블에 읽기 전용 SQL 쿼리 실행sql (string, 필수), project_id (uuid, 선택), limit (int 1-1000, 기본값 100)

분석

섹션 제목: “분석”
도구설명인수
get_dashboard프로젝트 KPI (DAU, MAU, 세션, 이벤트)project_id (uuid, 선택), days (7/14/30/90, 기본값 30)
get_retention코호트 리텐션 분석project_id (uuid, 선택), days (7/14/30/90, 기본값 30)
get_funnel이벤트 퍼널 분석project_id (uuid, 선택), steps (string, 필수: 쉼표 구분 2-8개 이벤트명), days (7/14/30/90, 기본값 30)
get_insights차원별 집계 인사이트project_id (uuid, 선택), metric (count/unique_players, 필수), group_by (string, 필수: event_name, platform 등), days (7/14/30/90, 기본값 30), limit (10/20/50), event_name (string, 선택)
get_heatmap맵의 히트맵 그리드 데이터project_id (uuid, 선택), map_id (string, 필수), cell_size (5/10/25/50, 기본값 25), days (1/7/14/30, 기본값 7), event_name (string, 선택)

프로젝트

섹션 제목: “프로젝트”
도구설명인수
list_projectsAPI 키에 연결된 프로젝트 표시없음
get_project_status프로젝트 상태 개요 (이벤트 수, 마지막 이벤트 시간)project_id (uuid, 선택)
list_maps프로젝트의 맵 목록project_id (uuid, 선택)
list_content콘텐츠 레지스트리 항목 목록project_id (uuid, 선택), type (string, 선택)

알림

섹션 제목: “알림”
도구설명인수
list_alerts알림 규칙 목록project_id (uuid, 선택)
get_alert_history알림 트리거/해제 이력project_id (uuid, 선택), limit (int 1-100, 기본값 50)

리소스

섹션 제목: “리소스”

framedash:// URI 스킴으로 MCP 리소스를 통해 데이터에 접근할 수 있습니다:

URI설명
framedash://projectsAPI 키에 연결된 프로젝트
framedash://projects/{projectId}/maps좌표 및 범위 포함 맵 목록
framedash://projects/{projectId}/content콘텐츠 레지스트리 항목
framedash://projects/{projectId}/status프로젝트 상태 및 통계

사용 예시

섹션 제목: “사용 예시”

MCP Server를 구성하면 자연어로 데이터를 조회할 수 있습니다:

프롬프트 예시사용되는 도구
”지난 7일간 DAU를 보여줘”get_dashboard (days=7)
“spawn에서 death까지의 퍼널을 분석해줘”get_funnel (steps=“player.spawn,player.death”)
“플랫폼별 이벤트 수를 알려줘”get_insights (metric=count, group_by=platform)
“맵의 FPS 히트맵을 보여줘”get_heatmap (map_id=…)
”최근 알림 이력을 확인해줘”get_alert_history

다음 단계

섹션 제목: “다음 단계”