Back to Details

remix-mcp-quickstart

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Recommended Flow

推荐工作流

Base URL: 
https://api.remix.gg
  1. Fetch OpenAPI JSON from 
    https://api.remix.gg/docs/json
    .
  2. Resolve exact methods/paths/schemas from the spec.
  3. GET /v1/metadata/categories
    to fetch valid category enums.
  4. POST /v1/games
  5. Build game code against 
    window.RemixSDK
    requirements, including SDK 
    <script>
    in HTML 
    <head>
    (
    https://cdn.jsdelivr.net/npm/@remix-gg/sdk@latest/dist/index.min.js
    ) (see the 
    remix-game-sdk
    skill)
  6. Set required metadata:
    • Name: game metadata APIs
    • Category: game metadata APIs (1-3)
    • Icon: upload via 
      POST /v1/games/{gameId}/assets
      or in Remix Studio/app flow
  7. Upload binary assets (icon/sprites/audio) via 
    POST /v1/games/{gameId}/assets
    or in Remix Studio/app flow.
  8. GET /v1/games/{gameId}/assets
    to confirm hosted asset URLs.
  9. POST /v1/games/{gameId}/versions/{versionId}/code
  10. GET /v1/games/{gameId}/versions/{versionId}/validate
  11. Optional: 
    GET /v1/games/{gameId}/launch-readiness?versionId={versionId}
  12. If blockers exist, patch code/metadata and repeat validation
  13. GET /v1/games/{gameId}/versions/{versionId}/status
基础URL: 
https://api.remix.gg
  1. 从
    https://api.remix.gg/docs/json
    获取OpenAPI JSON文件。
  2. 从规范中解析确切的方法/路径/模式。
  3. 调用
    GET /v1/metadata/categories
    获取有效的分类枚举值。
  4. 调用
    POST /v1/games
    接口
  5. 按照
    window.RemixSDK
    的要求编写游戏代码，在HTML的
    <head>
    中引入SDK的
    <script>
    标签（地址：
    https://cdn.jsdelivr.net/npm/@remix-gg/sdk@latest/dist/index.min.js
    ）（可参考
    remix-game-sdk
    技能）
  6. 设置必要的元数据：
    • 名称：游戏元数据API
    • 分类：游戏元数据API（1-3个）
    • 图标：通过
      POST /v1/games/{gameId}/assets
      上传，或在Remix Studio/应用流程中上传
  7. 通过
    POST /v1/games/{gameId}/assets
    上传二进制资源（图标/精灵/音频），或在Remix Studio/应用流程中上传。
  8. 调用
    GET /v1/games/{gameId}/assets
    确认托管资源的URL。
  9. 调用
    POST /v1/games/{gameId}/versions/{versionId}/code
  10. 调用
    GET /v1/games/{gameId}/versions/{versionId}/validate
  11. 可选步骤：调用
    GET /v1/games/{gameId}/launch-readiness?versionId={versionId}
  12. 如果存在阻塞项，修改代码/元数据并重复验证步骤
  13. 调用
    GET /v1/games/{gameId}/versions/{versionId}/status

Discovery / Inspection Endpoints

发现/检查接口

  • GET /v1/games
  • GET /v1/games/{gameId}
  • GET /v1/games/{gameId}/versions
  • GET /v1/games/{gameId}/versions/{versionId}
  • GET /v1/games/{gameId}/versions/{versionId}/code
  • GET /v1/games/{gameId}/versions/{versionId}/thread
  • GET /v1/games/{gameId}/assets
  • GET /v1/games/{gameId}/items
  • GET /v1/games
  • GET /v1/games/{gameId}
  • GET /v1/games/{gameId}/versions
  • GET /v1/games/{gameId}/versions/{versionId}
  • GET /v1/games/{gameId}/versions/{versionId}/code
  • GET /v1/games/{gameId}/versions/{versionId}/thread
  • GET /v1/games/{gameId}/assets
  • GET /v1/games/{gameId}/items

Guardrails

注意事项

  • Never skip validation checks.
  • Treat 
    blockers[]
    as source of truth.
  • Do not trust cached path/method memory when OpenAPI is available.
  • Do not create extra versions from agent REST.
  • Do not submit from agent REST.
  • If docs are stale, check 
    https://api.remix.gg/docs
    .
  • 绝不跳过验证检查。
  • 将
    blockers[]
    视为事实依据。
  • 当OpenAPI可用时，不要依赖缓存的路径/方法记忆。
  • 不要通过Agent REST创建额外版本。
  • 不要通过Agent REST提交内容。
  • 如果文档过时，请查看
    https://api.remix.gg/docs
    。