| name | remix-mcp-quickstart |
| description | Quickstart for the official Remix MCP server. Use when configuring or operating `@remix-gg/mcp`, wiring MCP auth, or choosing the right Remix MCP tools and skill resources. |
| metadata | {"tags":"remix, mcp, quickstart"} |
Install And Auth
Install the human-facing CLI if you want browser auth and reusable credentials:
curl -fsSL https://remix.gg/install.sh | bash
remix login
remix whoami
Then configure MCP:
claude mcp add remix-mcp -- npx -y @remix-gg/mcp
The MCP server reads auth from:
REMIX_API_KEY
- saved CLI credentials in
~/.config/remix/credentials.json
Project Settings
The current packaged MCP skills prefer this lookup order before createGame:
- task context or prior tool results
- nearest
.remix-cli.json
- legacy
.remix-mcp.json
Upstream MCP docs are still inconsistent in places and may mention .remix-settings.json. Treat that as stale guidance unless the specific project already uses it. The safe rule is: if you already have gameId and versionId, reuse them and do not call createGame.
Core Tool Set
createGame
updateGame
uploadVersion
generateImage
generateShopImage
uploadGameAsset
generateSpriteSheet
listShopItems
createShopItem
updateShopItem
deleteShopItem
Skill Resources
The server exposes skill resources under skills://...:
skills://overview
skills://game-creation
skills://upload-game
skills://implement-multiplayer
skills://integrate-save-game
skills://add-image-to-game
skills://manage-shop-items
skills://add-sprite-to-game
skills://migrate-mobile-fullscreen
skills://open-game
Load the matching skill resource before taking multi-step actions.
Recommended Flow
- Read task context first, then
.remix-cli.json, then legacy .remix-mcp.json.
- If no IDs exist, call
createGame.
- Build or repair the game against
window.RemixSDK requirements.
- Upload assets with
uploadGameAsset, generateImage, generateShopImage, or generateSpriteSheet as needed.
- Upload code with
uploadVersion.
- If the task involves monetization, run
listShopItems before creating or updating items.
- Use the matching workflow resource for detailed rules before continuing.
Guardrails
- Do not call
createGame when task context, .remix-cli.json, or legacy .remix-mcp.json already provides IDs.
- Do not read the HTML or asset file yourself before calling file-path-based MCP tools.
- Use CLI login or
REMIX_API_KEY; do not invent a separate MCP-only auth scheme.
- If package docs disagree, prefer the current package source in
packages/mcp/src.