MCP server

---

Two ways to connect

A. Hosted connector (no install)

Add https://api.getstoreready.com/mcp as a custom connector / remote MCP server. The first time, your AI app opens getstoreready.com — sign up or log in, click Allow, done. No API key to copy.

• Claude (web / desktop): Settings → Connectors → Add custom connector → paste the URL.
• Claude Code: claude mcp add --transport http getstoreready https://api.getstoreready.com/mcp
• ChatGPT, Cursor, others: add it as a remote / Streamable HTTP MCP server.

The hosted connector can't see your computer, so the local-only tools (detect_app, capture_screenshots, bootstrap_store_project, upload by file path, saving a store key from a file) are only in the local server below.

B. Local server (simulator capture, local files)

Every client below runs the same command. No API key needed — ask your agent to "sign in to GetStoreReady": the sign_in tool opens getstoreready.com/connect with a short code, you sign up or log in and click Allow, and the key is saved to ~/.config/getstoreready/credentials.json.

{
  "command": "npx",
  "args": ["-y", "github:getstoreready/getstoreready-mcp"]
}

Prefer a fixed key (CI, scripts)? Create one at getstoreready.com/profile/api-keys and set it as GSR_API_KEY in the server's env — it takes precedence over sign_in. The examples below show that optional env block.

Claude Code

Project-scoped (shared via .mcp.json committed to a repo):

claude mcp add getstoreready --scope project -- npx -y github:getstoreready/getstoreready-mcp

Optionally set GSR_API_KEY in your environment (otherwise use sign_in), or add it to the generated .mcp.json:

{
  "mcpServers": {
    "getstoreready": {
      "command": "npx",
      "args": ["-y", "github:getstoreready/getstoreready-mcp"],
      "env": { "GSR_API_KEY": "gsr_live_your_key_here" }
    }
  }
}

User-scoped (available in every project): same block in ~/.claude.json under mcpServers, or claude mcp add --scope user.

Claude Desktop

Settings → Developer → Edit Config (opens claude_desktop_config.json):

{
  "mcpServers": {
    "getstoreready": {
      "command": "npx",
      "args": ["-y", "github:getstoreready/getstoreready-mcp"],
      "env": { "GSR_API_KEY": "gsr_live_your_key_here" }
    }
  }
}

Cursor

Add to .cursor/mcp.json (project) or ~/.cursor/mcp.json (global):

{
  "mcpServers": {
    "getstoreready": {
      "command": "npx",
      "args": ["-y", "github:getstoreready/getstoreready-mcp"],
      "env": { "GSR_API_KEY": "gsr_live_your_key_here" }
    }
  }
}

Codex CLI

Add to ~/.codex/config.toml:

[mcp_servers.getstoreready]
command = "npx"
args = ["-y", "github:getstoreready/getstoreready-mcp"]

[mcp_servers.getstoreready.env]
GSR_API_KEY = "gsr_live_your_key_here"

Gemini CLI

Add to ~/.gemini/settings.json:

{
  "mcpServers": {
    "getstoreready": {
      "command": "npx",
      "args": ["-y", "github:getstoreready/getstoreready-mcp"],
      "env": { "GSR_API_KEY": "gsr_live_your_key_here" }
    }
  }
}

Tools

Account & billing

Tool	What it does
sign_in	Browser sign-in / sign-up (local server only) — no password or key in the chat
sign_out	Forget the saved key on this machine (local server only)
get_account	Signed-in email, plan, AI credit balance
list_plans	Plans and credit packs with prices
start_checkout	Payment link for a plan or credit pack — the user pays in their browser

App bootstrap (from local repo)

Tool	What it does
detect_app	Infer stack, app name, platforms, locales, and prioritized screens from a repo path.
discover_screenshots	Find PNG/JPG under marketing/, fastlane/screenshots/, screenshots/, etc.
capture_screenshots	Capture from iOS Simulator (simctl + optional Maestro) or Android (adb) into marketing/<locale>/. Prefer deepLinks or Maestro for distinct screens.
bootstrap_store_project	One-shot: detect → upload → create project → apply template → return text layers for copy.

Agent skill: getstoreready/getstoreready-skill — install with npx skills add getstoreready/getstoreready-skill.

Quick bootstrap:

1. detect_app({ appRootPath: "/path/to/app" })
2. discover_screenshots({ appRootPath }) — if empty, capture_screenshots({ appRootPath, platform: "ios" })
3. bootstrap_store_project({ appRootPath, templateKey: "random" })
4. update_screen_text per screen (optionally after get_screen_images + vision)
5. Optional: update_listing → translate_project → export_project → store push tools

Projects & templates

Tool	What it does
list_projects	List your GetStoreReady projects.
create_project	Create a new project. Returns its id and editor URL.
get_project	Project summary — platforms, languages, screen count, editor URL.
list_templates	List templates with your owned/locked state.
apply_template	Apply a template by key or "random". See recommended flow below.
upload_screenshots	Upload raw app screenshots — prefer local path over base64 data.
place_screenshot_image	Place an uploaded asset into a screen by 1-based index.

Free-form design (full editor parity)

Everything the web editor can do — free text with per-word highlight runs, any Google Font, device mockups with 3D tilt/lean and view presets, image & icon layers, edge fades, gradient/pattern/panorama backgrounds, per-device overrides (iPhone vs iPad vs Android), groups and z-order — is one Design JSON per screen. These tools read and write it directly; the vocabulary comes live from the API, so new editor features show up without an MCP update.

This is the beginning of the README. Read the rest at the original. Read the full README ↗