@sudomock/mcp 3.0.0 → 3.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 > Generate photorealistic product mockups from Claude, Cursor, Windsurf, and VS Code.
 
-[Model Context Protocol](https://modelcontextprotocol.io/introduction) server for the [SudoMock](https://sudomock.com) mockup generation API. Upload PSD templates, place artwork onto smart objects, edit supported text layers, turn a product photo into a reusable photo mockup, and get rendered image URLs -- all through natural language.
+[Model Context Protocol](https://modelcontextprotocol.io/introduction) server for the [SudoMock](https://sudomock.com) mockup generation API. Upload PSD templates, place artwork onto smart objects, edit supported text layers, and get rendered image URLs -- all through natural language.
 
 ## Quick Start
 
@@ -36,37 +36,34 @@ Get your API key at [sudomock.com/dashboard/api-keys](https://sudomock.com/dashb
 
 </details>
 
-> **Note:** This package ships the local stdio server shown above. The hosted
-> remote transport (OAuth, `https://mcp.sudomock.com`) is documented at
-> [sudomock.com/docs/mcp](https://sudomock.com/docs/mcp). From 3.0 of this
-> package and 2.0 of the hosted server the two transports use the same tool
-> names.
+> **Note:** A hosted remote (HTTP/OAuth) transport is not available yet. This
+> package only ships the local stdio server shown above.
 
 ## Tools
 
-Tools are named after the mockup family they act on: **PSD mockups** are
-uploaded Photoshop templates, **photo mockups** are made from a product photo.
-
 | Tool | Description | Credits |
 |------|-------------|---------|
-| `upload_psd` | Upload a Photoshop PSD/PSB template (sync or async) | 0 |
-| `list_psd_mockups` | List your uploaded PSD mockup templates | 0 |
-| `get_psd_mockup` | Get smart object UUIDs, editable text layers, dimensions, blend modes | 0 |
-| `update_psd_mockup` | Rename a PSD mockup template | 0 |
-| `delete_psd_mockup` | Delete a PSD mockup template | 0 |
-| `render_psd_mockup` | Render a PSD mockup with artwork and/or editable text | 1 |
-| `create_photo_mockup` | Create a photo mockup from a product photo and detect printable surfaces automatically | 25 |
-| `list_photo_mockups` | List saved photo mockups; use `customizable_only` for shopper-ready items | 0 |
-| `get_photo_mockup` | Get one photo mockup's saved print areas and its product surfaces | 0 |
-| `update_photo_mockup_print_areas` | Replace a photo mockup's print-area geometry | 0 |
-| `delete_photo_mockup` | Delete a photo mockup | 0 |
-| `render_photo_mockup` | Print artwork into one saved print area, or across a whole product surface | 5 |
+| `list_mockups` | List your uploaded mockup templates | 0 |
+| `get_mockup_details` | Get smart object UUIDs, dimensions, blend modes | 0 |
+| `render_mockup` | Render a mockup with artwork and/or editable text | 1 |
 | `remove_background` | Get a transparent-PNG cutout through a 7-day signed URL | 25 |
-| `render_video` | Animate a PSD mockup into a video clip (always async) | cost-based (one per account at no charge, then cost-based) |
+| `list_fonts` | List the fonts available for text layers, including your uploads | 0 |
+| `create_upload_url` | Get an upload URL for a local file and the file URL it will have | 0 |
+| `create_2d_mockup` | Create a photo mockup and detect printable surfaces automatically | 25 |
+| `render_2d_surface` | Print artwork across a whole product surface (all-over) | 5 |
+| `render_2d_print_area` | Print artwork into one saved print area (a drawn zone) | 5 |
+| `render_video` | Animate a mockup into a video clip (always async) | cost-based (one per account at no charge, then cost-based) |
+| `upload_psd` | Upload a Photoshop PSD/PSB template (sync or async) | 0 |
+| `list_2d_mockups` | List saved photo mockup templates; use `customizable_only` for shopper-ready items | 0 |
+| `get_2d_mockup` | Get one photo mockup's saved print areas and its product surfaces | 0 |
+| `update_2d_print_areas` | Replace a photo mockup's print-area geometry | 0 |
+| `delete_2d_mockup` | Delete a photo mockup template | 0 |
 | `get_job` | Check the status of an async job by job_id | 0 |
-| `wait_for_job` | Poll an async job until it succeeds, fails, or is cancelled | 0 |
+| `wait_for_job` | Poll an async job until it succeeds or fails | 0 |
 | `list_jobs` | List async render, video, upload, and photo mockup jobs | 0 |
 | `get_account` | Check plan, credits, prepaid balance, and usage | 0 |
+| `update_mockup` | Rename a mockup template | 0 |
+| `delete_mockup` | Delete a mockup template | 0 |
 | `create_webhook_endpoint` | Register a webhook for async job completion, pinned to an event naming | 0 |
 | `list_webhook_endpoints` | List your webhook endpoints | 0 |
 | `update_webhook_endpoint` | Edit or enable/disable a webhook endpoint | 0 |
@@ -75,15 +72,17 @@ uploaded Photoshop templates, **photo mockups** are made from a product photo.
 | `test_webhook_endpoint` | Send a signed `webhook.test` event | 0 |
 | `list_webhook_deliveries` | List delivery attempts for an endpoint | 0 |
 | `replay_webhook_delivery` | Replay a single failed delivery | 0 |
+| `replay_failed_webhook_deliveries` | Replay every failed delivery for an endpoint | 0 |
 
-### Renamed in 3.0
+### Both spellings work
 
-3.0 names every mockup tool after its family and keeps no alias for the old
-name, so a client written against 2.x fails at "tool not found" rather than
-being redirected to a tool whose arguments have changed.
+The product calls its two kinds of template PSD mockups and photo mockups, and
+the tools answer to those names too. Nothing above was renamed: every name in
+the table keeps working exactly as it always has, and the spelling beside it is
+the same tool with the same arguments. Reach for either.
 
-| 2.x | 3.0 |
-|-----|-----|
+| Name in the table | Also answers to |
+|------|------|
 | `list_mockups` | `list_psd_mockups` |
 | `get_mockup_details` | `get_psd_mockup` |
 | `update_mockup` | `update_psd_mockup` |
@@ -95,30 +94,38 @@ being redirected to a tool whose arguments have changed.
 | `update_2d_print_areas` | `update_photo_mockup_print_areas` |
 | `delete_2d_mockup` | `delete_photo_mockup` |
 | `render_2d_surface`, `render_2d_print_area` | `render_photo_mockup` |
-
-Photo mockup tools take `mockup_id`, the field `list_photo_mockups` and
-`create_photo_mockup` return. PSD mockup tools keep `mockup_uuid`.
+| `get_2d_mockup` | `get_2d_mockup_details` |
+| `test_webhook_endpoint` | `send_webhook_test_event` |
+| `render_photo_mockup` | `render_2d_mockup` |
+
+`render_photo_mockup` is the one that is not simply a second name for a single
+tool. It renders either kind of target from one tool: pass the mockup as
+`mockup_id` and name exactly one of `surface_uuid` (sized by `coverage` or an
+explicit `width` + `height`) or `print_area_uuid` (sized by `fit` or an
+explicit `width` + `height`). Picking the target by picking a tool, with
+`mockup_uuid`, is what `render_2d_surface` and `render_2d_print_area` still do.
+`render_2d_mockup` is `render_photo_mockup` under a second name, with the
+mockup passed as `mockup_uuid`.
 
 ### Async jobs
 
-`render_psd_mockup`, `upload_psd`, `create_photo_mockup`, and
-`render_photo_mockup` accept `is_async: true`, and `render_video` is always
-async. These return a `job_id` immediately (HTTP 202) instead of a final
-result. (`create_photo_mockup` and `render_photo_mockup` are synchronous by
-default and return the mockup / render directly.) Poll it with `get_job`, or
-let `wait_for_job` block until the job reaches a terminal status and hands back
-`result_url`, `mockup_uuid`, `credits_charged`, and `payg`
-(`{credits, unit_price, cost}` for pay-as-you-go jobs, otherwise `null`).
-
-A photo mockup render names exactly one target, read from `get_photo_mockup`.
-Every printable product in the photo is a surface with its own `surface_uuid`:
-pass it to print across the whole of one, with either a `coverage` percentage
-or an explicit `width` + `height`. A print area is a bounded zone somebody drew
-on a product, such as a chest logo: pass its `print_area_uuid`, with either a
-`fit` or an explicit `width` + `height`. A product can have both, and they are
-separate targets -- a saved print area does not close off the surface it sits
-on. The dial of the other kind of target (`fit` on a surface, `coverage` on a
-print area) is refused by name rather than dropped.
+`render_mockup`, `upload_psd`, `create_2d_mockup`, and both photo mockup render tools
+accept `is_async: true`, and `render_video` is always async. These return a
+`job_id` immediately (HTTP 202) instead of a final result. (`create_2d_mockup`
+and the photo mockup render tools are synchronous by default and return the mockup /
+render directly.) Poll it with `get_job`, or let `wait_for_job` block until the job
+reaches a terminal status and hands back `result_url`, `mockup_uuid`,
+`credits_charged`, and `payg` (`{credits, unit_price, cost}` for pay-as-you-go
+jobs, otherwise `null`).
+
+For a photo mockup render, pick the tool that matches the target you read from
+`get_2d_mockup`. Every printable product in the photo is a surface with its own
+`surface_uuid`: `render_2d_surface` prints across the whole of one, and takes
+either a `coverage` percentage or an explicit `width` + `height`. A print area
+is a bounded zone somebody drew on a product, such as a chest logo:
+`render_2d_print_area` takes its `print_area_uuid`, and either a `fit` or an
+explicit `width` + `height`. A product can have both, and they are separate
+targets -- a saved print area does not close off the surface it sits on.
 
 Sizing has one answer per render: send the relative option or the exact box,
 never both, and send `width` and `height` together. `position`, `offset_x`,
@@ -131,8 +138,8 @@ applies rather than a copy of it kept here.
 `remove_background` returns a transparent-PNG URL valid for 7 days. You can
 pass that URL straight back as `artwork_url` during that window. To clean
 artwork inline during a single render instead, pass
-`remove_background: true` to `render_psd_mockup` or `render_photo_mockup`. Either
-way it costs 25 credits per artwork, refunded automatically if processing fails.
+`remove_background: true` to `render_mockup` or either photo mockup render tool. Either way it
+costs 25 credits per artwork, refunded automatically if processing fails.
 
 ### Webhooks
 
@@ -158,9 +165,11 @@ The five photo mockup events also have a legacy spelling: `2d_mockup.ready`,
 `2d_render.failed` (with `kind` `2d_create` / `2d_render` in the payload).
 Which spelling an endpoint receives is its `event_naming` pin, set at
 `create_webhook_endpoint` and returned on every endpoint: `current` (the names
-above, the default for new endpoints) or `legacy`. Endpoints registered before
-the pin existed stay on `legacy`, so a receiver written against the old names
-keeps working unchanged. Once that receiver handles the new names, move it with
+above) or `legacy`. A create without a pin takes `current` only when
+`event_types` names photo mockup events by their family names alone, and
+`legacy` otherwise, including an empty list. Endpoints registered before the pin
+existed stay on `legacy`, so a receiver written against the old names keeps
+working unchanged. Once that receiver handles the new names, move it with
 `update_webhook_endpoint` and `event_naming: "current"`; sent on its own, the
 re-pin re-spells the endpoint's stored subscription list to match.
 
@@ -168,20 +177,18 @@ re-pin re-spells the endpoint's stored subscription list to match.
 
 Each tool call writes one JSON line to stderr, which your MCP host keeps in its
 log file: the tool name, how long the call took, and whether it succeeded, for
-example `{"event":"mcp_tool_call","tool":"list_psd_mockups","duration_ms":312,"ok":true}`.
+example `{"event":"mcp_tool_call","tool":"list_mockups","duration_ms":312,"ok":true}`.
 Arguments, API keys, file contents and API responses are never logged. Every
 API request identifies this package as `mcp-stdio/<version>` in its
 `User-Agent` and `X-SudoMock-Client` headers.
 
 ## Pricing and account limits
 
-Pay as you go is the entry tier, and it has no subscription. One PSD render costs
-**$0.10**, so $1 covers 10 of them. The minimum first payment is **$5**. Photo mockups
-and video are priced by what they cost to produce rather than at the flat render
-rate, which is why the Credits column above is not uniform.
-
-Volume plans start at **$25/month** for 5,000 renders. The lowest self-serve rate is
-**$2.42 per 1,000 renders**, on the annual Pro 50K plan.
+Subscriptions from **$0.002** per render. Without one, **$0.05** per render, the same
+rate standalone mockup APIs charge on a paid plan. Funding the balance takes a **$5**
+minimum first payment. Photo mockups and video are priced by
+what they cost to produce rather than at the flat render rate, which is why the
+Credits column above is not uniform.
 
 A new account starts with **500 credits, granted once**, and needs no card to spend
 them. Until a card is verified and the $5 minimum is funded, that account is in
@@ -205,11 +212,10 @@ as `0 / 0`.
 
 ## Example requests
 
-- "List my PSD mockup templates"
+- "List my mockup templates"
 - "Render the t-shirt mockup with this design: https://example.com/logo.png"
 - "Replace the editable headline text, then render the mockup"
 - "Cut out the background from this product photo, then render it on the tote bag"
-- "Turn this product photo into a mockup: https://example.com/tote.jpg"
 - "List my photo mockups, then render the first one with this artwork: https://example.com/logo.png"
 - "Render this design asynchronously and wait for it to finish"
 - "Queue that photo mockup render async and give me the job id to track"

package/dist/index.d.ts

@@ -3,8 +3,7 @@
  * SudoMock MCP Server
  *
  * Local stdio MCP server for Claude Desktop, Claude Code, Cursor, and VS Code.
- * Renders photorealistic product mockups from Photoshop PSD templates and
- * product photos via the SudoMock API.
+ * Renders photorealistic product mockups from Photoshop PSD templates via the SudoMock API.
  *
  * Auth: SUDOMOCK_API_KEY environment variable
  * Transport: stdio (local process)

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;;;;;;;GASG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAiLpE;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAgBzD;AAED,eAAO,MAAM,qBAAqB,aAAgD,CAAC;AAqdnF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAGnE;AAmFD,QAAA,MAAM,MAAM,WAGV,CAAC;AAk3CH,QAAA,MAAM,YAAY;;;;;;;;;CAGR,CAAC;AAEX,KAAK,UAAU,GAAG,MAAM,OAAO,YAAY,CAAC;AAE5C,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAsCzF;AAqFD,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAiLpE;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAgBzD;AAED,eAAO,MAAM,qBAAqB,aAAmC,CAAC;AAkhBtE;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAGnE;AA+FD,QAAA,MAAM,MAAM,WAGV,CAAC;AA2nDH,QAAA,MAAM,YAAY;;;;;;;;;CAGR,CAAC;AAEX,KAAK,UAAU,GAAG,MAAM,OAAO,YAAY,CAAC;AAE5C,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAsCzF;AAqYD,OAAO,EAAE,MAAM,EAAE,CAAC"}