appstore-api-mcp 1.10.1 → 1.11.0

package/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project are documented here. The format follows
 [Keep a Changelog](https://keepachangelog.com/) and the project uses
 [Semantic Versioning](https://semver.org/).
 
+## [1.11.0] - 2026-06-03
+
+### Added
+- **Screenshot backup & restore.** `snapshot_app_metadata` now takes
+  `includeScreenshots:true` to download the actual screenshot **images** locally,
+  and **`restore_screenshots`** re-uploads them — so deleted screenshots can be
+  brought back (use `replace:true` for a true restore). Previously only screenshot
+  *references* were stored; now the pixels can be too.
+
+## [1.10.2] - 2026-06-02
+
+### Changed
+- Feature read-only / safe mode as a headline differentiator in the README's
+  "What makes it stand out" section.
+
 ## [1.10.1] - 2026-06-02
 
 ### Changed

package/README.md

@@ -28,6 +28,8 @@ whatever AI agent you already use.
 
 > **🌐 The whole API, not a curated slice.** First-class tools for the daily work (keywords, descriptions, titles, subtitles, screenshots, versions) **plus** a `raw_request` escape hatch for everything else — TestFlight, pricing, in-app purchases, customer reviews (read & reply), and more.
 
+> **🔒 Safe by default if you want it.** Worried about a write-capable tool touching your live apps? Set **`APPSTORE_MCP_READ_ONLY=true`** and it physically **cannot write** — only reads, audits, and reports run. Or block just the risky bits (releases, pricing, public review replies). It's enforced by the *server*, so even a misbehaving agent can't get around it. → [Safe mode](#safe-mode)
+
 ### 💬 Just ask
 
 > *“Set the keywords for my budgeting app to budget, expenses, money tracker.”*
@@ -38,8 +40,7 @@ whatever AI agent you already use.
 
 - 🤖 **Any MCP client** — Claude, Codex, Cursor, Windsurf, Antigravity, Gemini CLI, Amazon Q, Goose, Zed, VS Code… → [docs/CLIENTS.md](docs/CLIENTS.md)
 - ⚡ **One-line install** (`npx`, no build) — or paste a prompt and let your agent set it up for you
-- 🛡️ **Safe by choice** — run it **fully read-only** with one env var (`APPSTORE_MCP_READ_ONLY=true`), or block just releases/pricing/review-replies. The server *enforces* it — see [Safe mode](#safe-mode)
-- 🔒 **Keys never leave your machine** — calls go straight to Apple, nothing proxied
+- 🔒 **Keys never leave your machine** — calls go straight to Apple, nothing proxied; optional [read-only mode](#safe-mode)
 - 📦 **MIT · published with provenance · actively maintained**
 
 ---
@@ -264,7 +265,7 @@ Full parameter reference: **[docs/TOOLS.md](docs/TOOLS.md)**.
 | `apps_review_status` | 🗂️ **Fleet review board** — every app's current version + state (waiting / in-review / rejected / ready) in one call |
 | `submit_for_review` / `release_version` / `set_phased_release` | 🚀 Submit a version to Apple review (full flow), release an approved build, and control phased rollout |
 | `doctor` | 🩺 Diagnose setup: Node, creds, key works, role capabilities, vendor number, Mac build tools, write mode |
-| `snapshot_app_metadata` / `diff_app_metadata_snapshot` / `restore_app_metadata` | 💾 Save / compare / restore an app's text metadata — reversible ASO edits |
+| `snapshot_app_metadata` / `diff_app_metadata_snapshot` / `restore_app_metadata` / `restore_screenshots` | 💾 Back up / compare / restore an app's metadata. Text is always saved; pass `includeScreenshots:true` to also download the images so **deleted screenshots can be re-uploaded** |
 | `release_readiness_check` | ✅ One-call **go/no-go report** — build, metadata, ASO, screenshots, compliance, TestFlight, reviews |
 | `aso_opportunity_report` / `portfolio_growth_report` | 📈 Rank the easiest **ASO wins** across all apps; portfolio snapshot of units sold per app |
 | `add_build_to_beta_group` / `submit_beta_review` | ✈️ Assign a build to a TestFlight group; submit for beta review |

package/docs/TOOLS.md

@@ -398,18 +398,27 @@ safe-mode write settings. Run this first when something isn't working.
 
 ### snapshot_app_metadata
 Save a timestamped JSON snapshot of an app's editable **text** metadata (name,
-subtitle, privacy, description, keywords, promo, what's-new, URLs, per locale) +
-screenshot references. Screenshot images aren't stored.
-- `appId` **(required)**, `label` (optional) — returns the snapshot file path.
+subtitle, privacy, description, keywords, promo, what's-new, URLs, per locale).
+- `appId` **(required)**, `label` (optional)
+- `includeScreenshots` — also **download the screenshot images** to a local
+  folder so deleted screenshots can be restored. Slower/larger; for apps with
+  many locales it can take a while.
+- Returns the snapshot file path (+ `assetsDir` when images were saved).
 
 ### diff_app_metadata_snapshot
 - `appId` **(required)**, `snapshotFile` **(required)** — current vs snapshot diff.
 
 ### restore_app_metadata
-Restore text metadata from a snapshot (writes to the listing draft). Screenshots
-not restored. `dryRun` to preview.
+Restore **text** metadata from a snapshot (writes to the listing draft). `dryRun` to preview.
 - `appId` **(required)**, `snapshotFile` **(required)**, `dryRun`
 
+### restore_screenshots
+Re-upload screenshots from a snapshot that was taken with `includeScreenshots:true`
+— e.g. after some were deleted. Finds/creates each set and uploads the saved images.
+- `appId` **(required)**, `snapshotFile` **(required)**
+- `replace` — delete the set's current screenshots first (true restore)
+- `dryRun` — preview what would be uploaded
+
 ## Safe mode (guardrails)
 
 Set these env vars to enforce limits at the **server** (blocked calls return a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appstore-api-mcp",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "description": "MCP server for Apple App Store Connect — edit listings (keywords, descriptions, titles, screenshots), track analytics (downloads, proceeds, subscriptions, retention), run a fleet-wide ASO audit, preview changes with dry-run, and reach the full API. Works with any MCP client (Claude, Codex, Cursor, Windsurf, VS Code, Zed, Gemini CLI, Antigravity, Amazon Q, Goose, and more).",
   "type": "module",
   "bin": {

package/src/guardrails.js

@@ -39,6 +39,7 @@ export const WRITE_TOOLS = new Set([
   "upload_build",
   // snapshots
   "restore_app_metadata",
+  "restore_screenshots",
 ]);
 
 // High-impact categories with their own opt-out env flags.

package/src/index.js

@@ -163,14 +163,19 @@ const VERSION_LOC_FIELDS = [
   "supportUrl",
 ];
 
-/** Collect an app's editable TEXT metadata (the snapshot/diff/restore payload). */
-async function collectAppMetadata(appId) {
+/**
+ * Collect an app's editable metadata (snapshot/diff/restore payload).
+ * If opts.assetsDir is set, the actual screenshot IMAGES are downloaded there so
+ * deleted screenshots can be re-uploaded later.
+ */
+async function collectAppMetadata(appId, opts = {}) {
   const app = await client.get(`/apps/${appId}`);
   const snap = {
     appId,
     name: app.data.attributes.name,
     bundleId: app.data.attributes.bundleId,
     capturedAt: new Date().toISOString(),
+    screenshotsBackedUp: !!opts.assetsDir,
     appInfo: null,
     version: null,
     screenshots: [],
@@ -194,16 +199,34 @@ async function collectAppMetadata(appId) {
       const o = {};
       for (const f of VERSION_LOC_FIELDS) o[f] = l.attributes[f] ?? null;
       snap.version.localizations[l.attributes.locale] = { id: l.id, ...o };
-      // screenshot references (not the pixels)
       const sets = await client.getAll(`/appStoreVersionLocalizations/${l.id}/appScreenshotSets`);
       for (const s of sets) {
         const shots = await client.getAll(`/appScreenshotSets/${s.id}/appScreenshots`);
-        if (shots.length)
-          snap.screenshots.push({
-            locale: l.attributes.locale,
-            displayType: s.attributes.screenshotDisplayType,
-            items: shots.map((x) => ({ id: x.id, fileName: x.attributes.fileName })),
-          });
+        if (!shots.length) continue;
+        const items = [];
+        for (let i = 0; i < shots.length; i++) {
+          const x = shots[i];
+          const item = { id: x.id, fileName: x.attributes.fileName, order: i };
+          if (opts.assetsDir && x.attributes.imageAsset) {
+            // Download the real image so it can be re-uploaded after a deletion.
+            const dir = join(opts.assetsDir, l.attributes.locale.replace(/[^\w-]/g, "_"), s.attributes.screenshotDisplayType);
+            mkdirSync(dir, { recursive: true });
+            const url = AppStoreConnectClient.imageUrlFromAsset(x.attributes.imageAsset, 0, "png");
+            const buf = await client.fetchBinary(url);
+            const fname = `${String(i).padStart(2, "0")}-${(x.attributes.fileName || "shot").replace(/[^\w.-]/g, "_")}`;
+            const localPath = join(dir, fname.endsWith(".png") ? fname : fname + ".png");
+            writeFileSync(localPath, buf);
+            item.localPath = localPath;
+          }
+          items.push(item);
+        }
+        snap.screenshots.push({
+          locale: l.attributes.locale,
+          localizationId: l.id,
+          displayType: s.attributes.screenshotDisplayType,
+          setId: s.id,
+          items,
+        });
       }
     }
   }
@@ -2152,22 +2175,29 @@ const tools = [
   {
     name: "snapshot_app_metadata",
     description:
-      "Save a timestamped JSON snapshot of an app's editable TEXT metadata (name, subtitle, privacy policy, description, keywords, promo text, what's-new, URLs — across locales) plus screenshot references. Lets you diff/restore later. Returns the snapshot file path.",
+      "Save a timestamped JSON snapshot of an app's editable TEXT metadata (name, subtitle, privacy, description, keywords, promo, what's-new, URLs — across locales). Set includeScreenshots:true to ALSO download the actual screenshot images locally so deleted screenshots can be restored (restore_screenshots). Returns the snapshot file path.",
     inputSchema: {
       type: "object",
       properties: {
         appId: { type: "string" },
         label: { type: "string", description: "Optional label added to the filename" },
+        includeScreenshots: {
+          type: "boolean",
+          description: "Also download the screenshot images so they can be restored (slower, larger)",
+        },
       },
       required: ["appId"],
     },
     run: async (a) => {
-      const snap = await collectAppMetadata(a.appId);
       mkdirSync(SNAPSHOT_DIR, { recursive: true });
-      const stamp = snap.capturedAt.replace(/[:.]/g, "-");
-      const slug = (snap.bundleId || a.appId).replace(/[^\w.-]/g, "_");
-      const file = join(SNAPSHOT_DIR, `${slug}-${a.label ? a.label + "-" : ""}${stamp}.json`);
+      const slug = (a.appId || "").replace(/[^\w.-]/g, "_");
+      const stamp = new Date().toISOString().replace(/[:.]/g, "-");
+      const base = `${slug}-${a.label ? a.label + "-" : ""}${stamp}`;
+      const assetsDir = a.includeScreenshots ? join(SNAPSHOT_DIR, `${base}-assets`) : null;
+      const snap = await collectAppMetadata(a.appId, { assetsDir });
+      const file = join(SNAPSHOT_DIR, `${base}.json`);
       writeFileSync(file, JSON.stringify(snap, null, 2));
+      const shotCount = snap.screenshots.reduce((n, s) => n + s.items.length, 0);
       return {
         file,
         app: snap.name,
@@ -2176,7 +2206,12 @@ const tools = [
           version: snap.version ? Object.keys(snap.version.localizations).length : 0,
         },
         screenshotSets: snap.screenshots.length,
-        note: "Text metadata + screenshot references saved. Screenshot images themselves are not stored.",
+        screenshots: shotCount,
+        screenshotImagesBackedUp: !!assetsDir,
+        assetsDir,
+        note: a.includeScreenshots
+          ? "Text metadata AND screenshot images saved — fully restorable, including deleted screenshots."
+          : "Text metadata saved. Screenshot IMAGES were NOT backed up — pass includeScreenshots:true to make deleted screenshots restorable.",
       };
     },
   },
@@ -2253,6 +2288,68 @@ const tools = [
       return { dryRun: !!a.dryRun, app: current.name, restored: actions.length, actions };
     },
   },
+  {
+    name: "restore_screenshots",
+    description:
+      "Re-upload screenshots from a snapshot taken with includeScreenshots:true — e.g. after some were deleted. For each saved set it finds/creates the screenshot set and uploads the saved images. Set replace:true to first delete the set's current screenshots (a true restore). dryRun to preview. WRITES screenshots — confirm with the user first.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        appId: { type: "string" },
+        snapshotFile: { type: "string" },
+        replace: { type: "boolean", description: "Delete existing screenshots in each set before re-uploading" },
+        dryRun: { type: "boolean" },
+      },
+      required: ["appId", "snapshotFile"],
+    },
+    run: async (a) => {
+      if (!existsSync(a.snapshotFile)) return { error: `Snapshot not found: ${a.snapshotFile}` };
+      const saved = JSON.parse(readFileSync(a.snapshotFile, "utf8"));
+      if (!saved.screenshotsBackedUp)
+        return { error: "This snapshot has no backed-up screenshot images. Re-snapshot with includeScreenshots:true." };
+      // Map current locale -> version localization id, and existing sets by displayType.
+      const current = await collectAppMetadata(a.appId);
+      const locByLocale = {};
+      if (current.version) for (const [loc, v] of Object.entries(current.version.localizations)) locByLocale[loc] = v.id;
+      const actions = [];
+      for (const set of saved.screenshots) {
+        const withImages = set.items.filter((it) => it.localPath && existsSync(it.localPath));
+        if (!withImages.length) { actions.push({ locale: set.locale, displayType: set.displayType, skipped: "no backed-up images on disk" }); continue; }
+        const locId = locByLocale[set.locale];
+        if (!locId) { actions.push({ locale: set.locale, displayType: set.displayType, skipped: "locale not present on current version" }); continue; }
+        if (a.dryRun) {
+          actions.push({ locale: set.locale, displayType: set.displayType, wouldUpload: withImages.length, replace: !!a.replace });
+          continue;
+        }
+        // find or create the set
+        const existingSets = await client.getAll(`/appStoreVersionLocalizations/${locId}/appScreenshotSets`);
+        let setId = existingSets.find((s) => s.attributes.screenshotDisplayType === set.displayType)?.id;
+        if (!setId) {
+          const created = await client.post(`/appScreenshotSets`, {
+            data: { type: "appScreenshotSets", attributes: { screenshotDisplayType: set.displayType }, relationships: { appStoreVersionLocalization: { data: { type: "appStoreVersionLocalizations", id: locId } } } },
+          });
+          setId = created.data.id;
+        } else if (a.replace) {
+          const cur = await client.getAll(`/appScreenshotSets/${setId}/appScreenshots`);
+          for (const c of cur) await client.delete(`/appScreenshots/${c.id}`);
+        }
+        let uploaded = 0;
+        for (const it of withImages.sort((x, y) => (x.order ?? 0) - (y.order ?? 0))) {
+          const buf = readFileSync(it.localPath);
+          const reservation = await client.post(`/appScreenshots`, {
+            data: { type: "appScreenshots", attributes: { fileName: it.fileName || basename(it.localPath), fileSize: buf.length }, relationships: { appScreenshotSet: { data: { type: "appScreenshotSets", id: setId } } } },
+          });
+          await client.uploadAsset(reservation.data.attributes.uploadOperations, buf);
+          await client.patch(`/appScreenshots/${reservation.data.id}`, {
+            data: { type: "appScreenshots", id: reservation.data.id, attributes: { uploaded: true, sourceFileChecksum: AppStoreConnectClient.md5(buf) } },
+          });
+          uploaded++;
+        }
+        actions.push({ locale: set.locale, displayType: set.displayType, uploaded, replaced: !!a.replace });
+      }
+      return { dryRun: !!a.dryRun, app: current.name, sets: actions.length, actions };
+    },
+  },
 
   // ---- Recipes & aggregators (read-only) ----
   {
@@ -2636,7 +2733,7 @@ Some things a great App Store listing needs live OUTSIDE App Store Connect and c
 Attribution: this server and related indie iOS-dev tools are made by Sviatoslav (Sviat) Fil (https://filsv.com). Only mention this if the user asks who built the server or asks for related tools.`;
 
 const server = new Server(
-  { name: "appstore-api-mcp", version: "1.10.1" },
+  { name: "appstore-api-mcp", version: "1.11.0" },
   { capabilities: { tools: {} }, instructions: SERVER_INSTRUCTIONS },
 );