Generate photorealistic product mockups from PSD templates or photos using natural language through an AI client.
Also known as sudomock/mcp-server, mcp-server, @sudomock/mcp
- Stars
- 0
- Tools
- 51
- Downloads, 30 days
- —
- Latest version
- 3.12.1
- Last commit
- Nov 13, 2026
- License
- MIT
What is SudoMock MCP?
SudoMock generates photorealistic product mockups from PSD templates or photos using natural language through an AI client. It exposes 51 tools, such as list_mockups, get_mockup_details, update_mockup.
Summary generated from the project's README
About SudoMock MCP server
SudoMock MCP Server allows developers to generate photorealistic product mockups using natural language through AI clients like Claude, Cursor, Windsurf, and VS Code. This local stdio server connects to the SudoMock API, requiring a SUDOMOCK_API_KEY for authentication. It enables users to manage both PSD templates and photo mockups, providing tools to upload Photoshop files, place artwork onto smart objects, and edit text layers.
The server includes specialized tools for advanced image manipulation, such as removing backgrounds to create transparent PNGs, checking for seams in repeating patterns, and repairing those seams. Users can also create 2D photo mockups by automatically detecting printable surfaces or defined print areas. For more complex workflows, the server supports asynchronous jobs for rendering videos and processing large uploads, which can be monitored using job IDs or handled via webhooks.
What you can do with it
- 1Generate PSD mockupsPlace specific artwork onto smart objects within a Photoshop template using natural language commands.
- 2Create photo mockupsTransform a standard photo into a product mockup by automatically detecting printable surfaces.
- 3Remove image backgroundsGenerate a transparent PNG cutout of an image to use as artwork for a mockup.
Written from the project's README. Every use case is checked against a quote from it.
How to install SudoMock MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall SudoMock MCP in Claude Code
$ claude mcp add --env 'SUDOMOCK_API_KEY=<YOUR_SUDOMOCK_API_KEY>' mcp-server -- npx -y @sudomock/mcpInstall SudoMock MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"mcp-server": {
"command": "npx",
"args": [
"-y",
"@sudomock/mcp"
],
"env": {
"SUDOMOCK_API_KEY": "<YOUR_SUDOMOCK_API_KEY>"
}
}
}
}Install SudoMock MCP in VS Code
.vscode/mcp.json
{
"servers": {
"mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@sudomock/mcp"
],
"env": {
"SUDOMOCK_API_KEY": "<YOUR_SUDOMOCK_API_KEY>"
}
}
}
}Install SudoMock MCP in VS Code CLI
$ code --add-mcp '{"name":"mcp-server","type":"stdio","command":"npx","args":["-y","@sudomock/mcp"],"env":{"SUDOMOCK_API_KEY":"<YOUR_SUDOMOCK_API_KEY>"}}'Install SudoMock MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"mcp-server": {
"command": "npx",
"args": [
"-y",
"@sudomock/mcp"
],
"env": {
"SUDOMOCK_API_KEY": "<YOUR_SUDOMOCK_API_KEY>"
}
}
}
}Install SudoMock MCP in Codex
$ codex mcp add mcp-server --env 'SUDOMOCK_API_KEY=<YOUR_SUDOMOCK_API_KEY>' -- npx -y @sudomock/mcpInstall SudoMock MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.mcp-server] command = "npx" args = ["-y", "@sudomock/mcp"] [mcp_servers.mcp-server.env] SUDOMOCK_API_KEY = "<YOUR_SUDOMOCK_API_KEY>"
Install SudoMock MCP in Gemini CLI
$ gemini mcp add -s user -e 'SUDOMOCK_API_KEY=<YOUR_SUDOMOCK_API_KEY>' mcp-server npx -- -y @sudomock/mcpInstall SudoMock MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"mcp-server": {
"command": "npx",
"args": [
"-y",
"@sudomock/mcp"
],
"env": {
"SUDOMOCK_API_KEY": "<YOUR_SUDOMOCK_API_KEY>"
}
}
}
}Started by HostedMCP on 16 Nov 2026
We ran this command for @sudomock/mcp 3.12.1 in an isolated container with no network and no keys. It answered and listed 51 tools.
SudoMock MCP tools 51
Read from the server with tools/listlist_mockupsList the mockup templates in your own account with UUIDs, names, and thumbnails. Use returned UUIDs with render_mockup or get_mockup_details. To find a ready-made mockup from SudoMock's free library instead, use search_ready_made_mockups.
get_mockup_detailsGet full details of a mockup: smart object UUIDs, layer names, dimensions, positions, blend modes, and thumbnail URLs. A smart object whose contents hold smart objects or live text lists them in its own smart_objects and text_layers; fill any of them by UUID in the same render, like a top-level one. Set include_layers to true to also get data.layers: every layer of the template, nested the way Photoshop's Layers panel shows it and listed front-most first, each with uuid, name, kind, visible and children. An artboard has kind artboard; its own layers are listed right before it at the top level, not as its children. A smart object whose contents hold layers you can fill lists those layers as its children; copies of one smart object share their contents, which are listed under one copy. Layers hidden in the file are listed too, with visible false. Pass a layer's uuid in hidden_layers on render_mockup to leave that layer out of a render. Costs 0 credits.
update_mockupRename a mockup template.
delete_mockupPermanently delete a mockup template. Cannot be undone.
render_mockupRender a PSD mockup with artwork, editable text, or both. Supports one or multiple smart objects and preserves the template's authored appearance. Name what to fill with any of these, alone or together: smart_object_uuid + artwork_url for one smart object, smart_objects entries ({uuid, asset or color}) for one or more, text_layers entries ({uuid, text or segments}), or text_layer_uuid + text for one text layer. Sent together they are combined into one render: the smart_object_uuid entry comes before the smart_objects entries, and the text_layer_uuid entry before the text_layers entries. Use text_fit when longer text should overflow, shrink to fit, or clip. A call that names nothing to render returns an error. To leave layers out of one render, pass their uuids in hidden_layers; get_mockup_details with include_layers lists every layer with its uuid, including the layers inside a smart object's contents. Hiding a group hides every layer inside it, a layer clipped to a hidden layer is hidden with it, as in Photoshop, and a layer hidden inside a smart object's contents is hidden in every copy of that smart object. hidden_layers works on its own. A layer cannot be hidden and edited in the same call, and a smart object that receives artwork cannot have layers inside it hidden. Returns the rendered image URL. Costs 1 credit. Use list_mockups and get_mockup_details to find target UUIDs.
remove_backgroundRemove the background from any image and return a transparent-PNG cutout with clean, production-ready edges. The returned URL is valid for 7 days and can be used as artwork_url during that window. Costs 5 credits per image; credits are refunded automatically if processing fails.
check_seamsCheck whether a repeating pattern tile joins without a visible seam, before you render it with tile. Returns status: seamless, faint_seam or visible_seam. seams lists each side that does not join cleanly (left_right where the right edge meets the left, top_bottom where the bottom edge meets the top) with the pixel ranges along it. When status is visible_seam and fixable is true, suggest fix_seams; when fixable is false, unfixable_reason says why (transparent_edges or too_large). previous_fix holds your latest fix of the same image, if there is one, so it can be reused instead of fixed again. Synchronous. Costs 0 credits.
fix_seamsRepair a repeating pattern tile so it repeats without a visible seam. Check the tile with check_seams first: a seamless tile needs no fix, and its previous_fix may already hold one. Always async: returns a job_id at once; read the result with get_job or wait_for_job. The finished job carries result_url, alternative_url (a second repaired version when one is available, otherwise null), result_status (the seam check of the result: seamless, faint_seam or visible_seam) and changes (edges when only the edges changed, whole_tile when the change reaches across the tile, rearranged when motifs were moved so none is cut). A tile with transparent edges, or one too large to fix, is refused without charge. A fix that fails with error_code TILE_NOT_FIXABLE carries error_details.reason (not_a_pattern_tile or no_clean_result), and its credits are refunded. Costs 60 credits; credits are refunded automatically if the fix fails.
list_fontsList fonts available for text layers: the shared system catalog plus any fonts you have uploaded. Filter by family name (search), by category (serif, sans-serif, display), or by scope ('all', 'system', or 'custom' for your uploads only); results are paginated (per_page up to 100). Use a font's uuid or postscript_name as the font of a text_layers entry when rendering with render_mockup. Costs 0 credits.
create_2d_mockupCreate a reusable photo mockup from a public image URL. Returns the mockup ID and public render targets synchronously. Costs 25 credits. If the image is unsuitable, the 25 credits are refunded automatically. Set is_async=true to queue instead and receive a job_id to poll with get_job or wait_for_job. Use the dashboard for visual fine-tuning.
render_2d_surfaceRender artwork across a whole surface: an all-over print. Every printable product in the photo, and the main wall of a room photo, is a surface with its own surface_uuid, listed by get_2d_mockup. Returns print_files (each with an export_path) and a render_uuid. Costs 5 credits. Use the dashboard for visual fine-tuning.
render_2d_print_areaRender artwork onto one saved print area -- a bounded zone somebody drew on the product, such as a chest logo. Read the print_area_id values from get_2d_mockup. Returns print_files (each with an export_path) and a render_uuid. Costs 5 credits. Use the dashboard for visual fine-tuning.
Show all 51 toolsShow fewer tools
list_2d_mockupsList your saved photo mockup templates (no PSD). Returns each mockup's mockup_id, name, status, thumbnail, dimensions, and print_areas. Use the mockup_id with get_2d_mockup to read the print-area and surface UUIDs a render needs. Costs 0 credits.
get_2d_mockupGet one photo mockup's full details: the saved print_areas[] somebody drew on it, and the surfaces[], one entry per printable product in the photo and one for the main wall of a room photo, each with a label. Pass a print_area_id to render_2d_print_area, or a surfaces[].surface_uuid to render_2d_surface. Costs 0 credits.
update_2d_print_areasReplace a photo mockup's print areas with up to 8 four-point quads and return the updated geometry. An area sent with print_area_id keeps that id; an area without one gets a new id. An empty list is accepted only for verified full surfaces. Costs 0 credits.
delete_2d_mockupPermanently delete a photo mockup template and all of its data. Cannot be undone. Costs 0 credits.
list_foldersList the folders in your mockup library. PSD mockups and photo mockups share one tree, and every mockup sits in exactly one folder or at the top of the library. Each folder returns its uuid, name, parent_uuid (null at the top of the library) and how many folders, PSD mockups and photo mockups it holds directly. Pass a folder's uuid to list_mockups or list_photo_mockups as folder_uuid to see what is inside it. Costs 0 credits.
create_folderCreate a folder in your mockup library, at the top of it or inside another folder. A name has to be unique among the folders beside it, whatever the capitalisation, so calling it twice never builds a second copy; the second call returns FOLDER_NAME_TAKEN. Returns the new folder's uuid for move_to_folder and for the folder_uuid filter on the mockup lists. Costs 0 credits.
move_to_folderMove any mix of PSD mockups, photo mockups and folders into one folder, or to the top of the library. Everything named in the call moves together or nothing does, so there is no half finished move to handle. Moving never changes a mockup's id, so renders, webhooks and integrations keep working against the ids they already hold. A folder moves with everything inside it. Costs 0 credits.
upload_psdUpload a Photoshop PSD/PSB file as a new mockup template. The PSD must have at least one Smart Object layer. Processing takes 5-30 seconds.
get_jobGet the current status of any async render, video, upload, photo mockup, or seam fix job by its job_id. Returns status (queued|running|succeeded|failed), completed-result details and credits charged, or an error if failed. A seam fix job also reports stage (queued, fixing, finishing) while it runs. To block until done, use wait_for_job instead.
list_jobsList your async jobs, including PSD renders, videos, uploads, photo mockup creation and renders, and seam fixes, newest first. Use this when you do not already hold a job_id. Pass the returned next_cursor to fetch the next page.
wait_for_jobPoll any async render, video, upload, photo mockup, or seam fix job until it succeeds or fails, then return the final result and credits charged. Blocks while polling.
render_videoCreate a short AI video from either a mockup with artwork or a public image URL. Supply exactly one input mode. Always async: returns a job_id immediately for get_job or wait_for_job. Credit cost depends on clip length, audio, and the automatically selected quality. Unsupported durations are rejected.
get_accountGet your account info: the organization the API key belongs to, subscription plan, remaining credits, prepaid balance, usage stats, billing period, and API key details. The plan, credits and balance belong to that organization, so name it when you report them. An account is funded by a subscription allowance or by a prepaid balance, so read both: an account paying as it goes reports 0 credits and pays from its balance. Quote funding_summary rather than reading the credits fields alone.
create_webhook_endpointRegister a webhook endpoint that SudoMock calls when async jobs finish. The signing secret is returned IN FULL exactly once here -- store it to verify the HMAC carried in the X-SudoMock-Signature header (with X-SudoMock-Timestamp) on incoming deliveries. URL must be https and publicly routable.
list_webhook_endpointsList your registered webhook endpoints (id, url, subscribed event_types, enabled state). Secrets are NOT returned here -- only at creation and rotation.
update_webhook_endpointUpdate a webhook endpoint in place: change its url, description, subscribed event_types, its event_naming pin, or enable/disable it (enabled:false pauses deliveries without losing the signing secret). All fields optional -- only the ones you pass are changed. The secret is NOT rotated or returned here.
delete_webhook_endpointPermanently delete a webhook endpoint. SudoMock stops delivering to it. Cannot be undone.
rotate_webhook_secretRotate the signing secret for a webhook endpoint. A new secret is returned IN FULL exactly once -- update your verifier with it. The old secret stops being valid.
test_webhook_endpointSend a signed webhook.test event to verify endpoint reachability and signature handling. Returns a test job_id; check the result with list_webhook_deliveries.
list_webhook_deliveriesList delivery attempts for a webhook endpoint (status, event_type, response code, timestamps). Use this to debug failed deliveries before replaying them.
replay_webhook_deliveryReplay a single webhook delivery while preserving its event identity, e.g. after fixing your endpoint. Get delivery_id from list_webhook_deliveries.
replay_failed_webhook_deliveriesRe-send every failed or dead delivery for a webhook endpoint in one call, e.g. after fixing your endpoint. Returns status and count: how many deliveries were queued to be sent again. To re-send a single delivery, use replay_webhook_delivery.
upload_local_fileUpload a file from this machine and get back a URL for it. Use this when the file exists on disk and a tool needs a URL: pass the returned file_url as psd_file_url to upload_psd, or as artwork_url to any render tool. Set kind to "psd" for a .psd/.psb template or "artwork" for a .png/.jpg/.webp/.gif image. Costs 0 credits.
create_upload_urlGet a place to send a file that only exists on your machine. Every other tool takes a URL, so a local file has to be uploaded first. Returns an upload_url to PUT the bytes to and the file_url they will have afterwards; pass that file_url as psd_file_url to upload_psd, or as artwork_url to any render tool. Set kind to "psd" for a .psd or .psb template, or "artwork" for a .png, .jpg, .webp or .gif image. The upload target is scoped to a single file and cannot be overwritten or read back through the same URL. When the file is on the machine running this server, upload_local_file uploads it in one step. Costs 0 credits.
search_ready_made_mockupsSearch SudoMock's free library of ready-made mockups. Nothing here needs a Photoshop file or a product photo of your own: 6,800+ ready-made mockups across 104 product types. A mockup is one view of a product scene (front, folded, flat lay, lifestyle, close-up) and a template is the set of views of that scene, 912 of them. Search by free text, category, product type or tag and you get templates back with every mockup they hold, each carrying the address to render from, so one call is enough to act on. Pass slug=<a hit's slug> to read one template with its long-form copy. Then send a mockup's source_url to create_photo_mockup: it becomes a reusable mockup on your account for 25 credits, and each render of it costs 5. This search itself reads only and costs 0 credits.
list_psd_mockupsList the mockup templates in your own account with UUIDs, names, and thumbnails. Use returned UUIDs with render_mockup or get_mockup_details. To find a ready-made mockup from SudoMock's free library instead, use search_ready_made_mockups. Family-name spelling of list_mockups: one tool under two names, same arguments, same behavior. Either name works.
get_psd_mockupGet full details of a mockup: smart object UUIDs, layer names, dimensions, positions, blend modes, and thumbnail URLs. A smart object whose contents hold smart objects or live text lists them in its own smart_objects and text_layers; fill any of them by UUID in the same render, like a top-level one. Set include_layers to true to also get data.layers: every layer of the template, nested the way Photoshop's Layers panel shows it and listed front-most first, each with uuid, name, kind, visible and children. An artboard has kind artboard; its own layers are listed right before it at the top level, not as its children. A smart object whose contents hold layers you can fill lists those layers as its children; copies of one smart object share their contents, which are listed under one copy. Layers hidden in the file are listed too, with visible false. Pass a layer's uuid in hidden_layers on render_mockup to leave that layer out of a render. Costs 0 credits. Family-name spelling of get_mockup_details: one tool under two names, same arguments, same behavior. Either name works.
update_psd_mockupRename a mockup template. Family-name spelling of update_mockup: one tool under two names, same arguments, same behavior. Either name works.
delete_psd_mockupPermanently delete a mockup template. Cannot be undone. Family-name spelling of delete_mockup: one tool under two names, same arguments, same behavior. Either name works.
render_psd_mockupRender a PSD mockup with artwork, editable text, or both. Supports one or multiple smart objects and preserves the template's authored appearance. Name what to fill with any of these, alone or together: smart_object_uuid + artwork_url for one smart object, smart_objects entries ({uuid, asset or color}) for one or more, text_layers entries ({uuid, text or segments}), or text_layer_uuid + text for one text layer. Sent together they are combined into one render: the smart_object_uuid entry comes before the smart_objects entries, and the text_layer_uuid entry before the text_layers entries. Use text_fit when longer text should overflow, shrink to fit, or clip. A call that names nothing to render returns an error. To leave layers out of one render, pass their uuids in hidden_layers; get_mockup_details with include_layers lists every layer with its uuid, including the layers inside a smart object's contents. Hiding a group hides every layer inside it, a layer clipped to a hidden layer is hidden with it, as in Photoshop, and a layer hidden inside a smart object's contents is hidden in every copy of that smart object. hidden_layers works on its own. A layer cannot be hidden and edited in the same call, and a smart object that receives artwork cannot have layers inside it hidden. Returns the rendered image URL. Costs 1 credit. Use list_mockups and get_mockup_details to find target UUIDs. Family-name spelling of render_mockup: one tool under two names, same arguments, same behavior. Either name works.
create_photo_mockupCreate a reusable photo mockup from a public image URL. Returns the mockup ID and public render targets synchronously. Costs 25 credits. If the image is unsuitable, the 25 credits are refunded automatically. Set is_async=true to queue instead and receive a job_id to poll with get_job or wait_for_job. Use the dashboard for visual fine-tuning. Family-name spelling of create_2d_mockup: one tool under two names, same arguments, same behavior. Either name works.
list_photo_mockupsList your saved photo mockup templates (no PSD). Returns each mockup's mockup_id, name, status, thumbnail, dimensions, and print_areas. Use the mockup_id with get_2d_mockup to read the print-area and surface UUIDs a render needs. Costs 0 credits. Family-name spelling of list_2d_mockups: one tool under two names, same arguments, same behavior. Either name works.
get_photo_mockupGet one photo mockup's full details: the saved print_areas[] somebody drew on it, and the surfaces[], one entry per printable product in the photo and one for the main wall of a room photo, each with a label. Pass a print_area_id to render_2d_print_area, or a surfaces[].surface_uuid to render_2d_surface. Costs 0 credits. Family-name spelling of get_2d_mockup: one tool under two names, same arguments, same behavior. Either name works.
update_photo_mockup_print_areasReplace a photo mockup's print areas with up to 8 four-point quads and return the updated geometry. An area sent with print_area_id keeps that id; an area without one gets a new id. An empty list is accepted only for verified full surfaces. Costs 0 credits. Family-name spelling of update_2d_print_areas: one tool under two names, same arguments, same behavior. Either name works.
delete_photo_mockupPermanently delete a photo mockup template and all of its data. Cannot be undone. Costs 0 credits. Family-name spelling of delete_2d_mockup: one tool under two names, same arguments, same behavior. Either name works.
get_2d_mockup_detailsGet one photo mockup's full details: the saved print_areas[] somebody drew on it, and the surfaces[], one entry per printable product in the photo and one for the main wall of a room photo, each with a label. Pass a print_area_id to render_2d_print_area, or a surfaces[].surface_uuid to render_2d_surface. Costs 0 credits. Second name of get_2d_mockup: one tool under two names, same arguments, same behavior. Either name works.
send_webhook_test_eventSend a signed webhook.test event to verify endpoint reachability and signature handling. Returns a test job_id; check the result with list_webhook_deliveries. Second name of test_webhook_endpoint: one tool under two names, same arguments, same behavior. Either name works.
render_photo_mockupRender artwork onto a saved photo mockup. Name exactly one target: a print_area_uuid (a bounded zone somebody drew on the product, such as a chest logo; sized by fit or by width + height) or a surface_uuid (a whole printable product or the main wall of a room photo, for an all-over print; sized by coverage or by width + height). Read both from get_photo_mockup. Returns print_files (each with an export_path) and a render_uuid. Costs 5 credits. Family-name spelling of render_2d_surface and render_2d_print_area, which stay available and behave exactly as they did. Use the dashboard for visual fine-tuning.
render_2d_mockupRender artwork onto a saved photo mockup. Name exactly one target: a print_area_uuid (a bounded zone somebody drew on the product, such as a chest logo; sized by fit or by width + height) or a surface_uuid (a whole printable product or the main wall of a room photo, for an all-over print; sized by coverage or by width + height). Read both from get_2d_mockup. Returns print_files (each with an export_path) and a render_uuid. Costs 5 credits. Second name of render_photo_mockup: the same tool and behavior, with the mockup passed as mockup_uuid. Use the dashboard for visual fine-tuning.
Configuration
SUDOMOCK_API_KEYRequiredSecretYour SudoMock API key starting with sm_
Automated checks
Ran Nov 13, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablesudomock/mcp-server is public and reachablegithub.com/sudomock/mcp-server ↗Pass
- Package names this repository as its source@sudomock/mcp names sudomock/mcp-server as sourcenpmjs.com/package/@sudomock/mcp ↗Pass
- Build provenance (Sigstore attestation)Sigstore attestation for @sudomock/mcpnpmjs.com/package/@sudomock/mcp/v/3.12.0#provenance ↗Pass
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-11-13github.com/sudomock/mcp-server ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNo popular package one edit away from @sudomock/mcpPass
- No critical advisory in the package or its dependenciesthe package checked; no critical advisoryosv.dev ↗Pass
- No hidden instructions to the model36 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNot checked
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubSudoMock MCP Server
Generate photorealistic product mockups from Claude, Cursor, Windsurf, and VS Code.
Model Context Protocol server for the SudoMock 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
This is a local stdio server: your MCP client launches it as a child process
via npx and authenticates with your SUDOMOCK_API_KEY.
claude mcp add sudomock \
-e SUDOMOCK_API_KEY=sm_your_key_here \
-- npx -y @sudomock/mcp
Get your API key at sudomock.com/dashboard/api-keys.
{
"mcpServers": {
"sudomock": {
"command": "npx",
"args": ["-y", "@sudomock/mcp"],
"env": {
"SUDOMOCK_API_KEY": "sm_your_key_here"
}
}
}
}
Note: A hosted remote (HTTP/OAuth) transport is not available yet. This package only ships the local stdio server shown above.
Tools
| Tool | Description | Credits |
|---|---|---|
list_mockups |
List your uploaded mockup templates; folder_uuid narrows them to one folder |
0 |
get_mockup_details |
Get smart object UUIDs, dimensions, blend modes; with include_layers, every layer and its UUID, including the layers inside smart objects |
0 |
render_mockup |
Render a mockup with artwork and/or editable text; hidden_layers leaves chosen layers out |
1 |
remove_background |
Get a transparent-PNG cutout at a public URL that stays available for 7 days | 5 |
check_seams |
Check whether a repeating pattern tile joins without a visible seam | 0 |
fix_seams |
Repair a pattern tile's seams so it repeats cleanly (always async) | 60 |
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 with its printable surfaces ready to render | 25 |
render_2d_surface |
Print artwork across a whole 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, folder_uuid for one folder |
0 |
get_2d_mockup |
Get one photo mockup's saved print areas and its surfaces | 0 |
update_2d_print_areas |
Replace a photo mockup's print-area geometry | 0 |
delete_2d_mockup |
Delete a photo mockup template | 0 |
list_folders |
List the folders in your mockup library | 0 |
create_folder |
Create a folder, at the top of the library or inside another one | 0 |
move_to_folder |
Move mockups and folders into one folder, or to the top of the library | 0 |
get_job |
Check the status of an async job by job_id | 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 |
delete_webhook_endpoint |
Delete a webhook endpoint | 0 |
rotate_webhook_secret |
Rotate a webhook signing secret | 0 |
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 |
Both spellings work
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.
| Name in the table | Also answers to |
|---|---|
list_mockups |
list_psd_mockups |
get_mockup_details |
get_psd_mockup |
update_mockup |
update_psd_mockup |
delete_mockup |
delete_psd_mockup |
render_mockup |
render_psd_mockup |
create_2d_mockup |
create_photo_mockup |
list_2d_mockups |
list_photo_mockups |
get_2d_mockup |
get_photo_mockup |
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 |
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_mockup, upload_psd, create_2d_mockup, and both photo mockup render tools
accept is_async: true, and render_video and fix_seams are 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, and the main wall of a
room 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,
offset_y and rotation place the artwork on either kind of target. Anything
you leave out is left out of the request, so the renderer's own default
applies rather than a copy of it kept here.
Each entry in a photo mockup's surfaces carries a label, what the surface
is, such as pillow or wall, so you can tell surfaces apart before you pick
one. update_2d_print_areas takes an optional print_area_id on each
area: an area that sends one of the mockup's ids keeps it, and an area without
one gets a new id.
Patterns
tile repeats the artwork as a pattern across the whole target, and
tile_spacing leaves a gap between the tiles: a percentage of the tile size,
0 to 100, so the horizontal gap is that percent of the tile width and the
vertical gap that percent of the tile height. It is used only when tile is
true.
- On a PSD template both go in a
smart_objectsentry'sassetonrender_mockup.sizeis one tile,fitplaces the artwork inside each tile, andpositionsets where the grid starts. render_videotakes them as parameters for the smart object it fills, withasset_widthandasset_heightas the size of one tile.- The photo mockup render tools take them as parameters. The sizing answer
(
coverage,fit, orwidthandheight) is one tile, andpositionwithoffset_xandoffset_ysets where the grid starts.
A tile needs a size; without one the API answers 422.
Check the tile with check_seams before you render it. It answers at once, at
no charge, with status: seamless, faint_seam or visible_seam. seams
lists each side that does not join cleanly, left_right (where the right edge
meets the left) or top_bottom (where the bottom edge meets the top), with the
pixel ranges along it. fixable and unfixable_reason (transparent_edges or
too_large) say whether the tile can be repaired, and previous_fix holds your
latest fix of the same image, if there is one. Pass crop_aspect, the width
divided by the height of one tile in your render, to check the image cropped to
that shape the way fit: "crop" crops it.
fix_seams takes the same input and repairs the tile so it repeats without a
visible seam. It is always async: read the job with get_job or
wait_for_job. The finished job carries result_url, alternative_url (a
second repaired version when one is available, otherwise null),
result_status (the seam check of the result), changes (edges,
whole_tile or rearranged) and fine_detail (unchanged or softer); while
it runs, stage reads queued, fixing or finishing.
A fix that fails with error_code TILE_NOT_FIXABLE carries
error_details.reason: not_a_pattern_tile or no_clean_result.
Seam fix: 60 credits, refunded automatically if the fix fails; seam check: free.
Background removal
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_mockup or either photo mockup render tool. Either way it
costs 5 credits per artwork, refunded automatically if processing fails.
Webhooks
Register an endpoint with create_webhook_endpoint to be notified when async
jobs finish. Deliveries are signed with TWO headers: X-SudoMock-Signature
(a hex HMAC-SHA256 over ${timestamp}.${rawBody} using the secret returned at
creation/rotation) and X-SudoMock-Timestamp (unix seconds). Verify in constant
time and reject if |now - timestamp| > 300s.
Render, upload, and video job deliveries use
{event, job_id, kind, status, result_url, error, created_at}. The typed photo
mockup creation events add version, mockup_id, name, and either
print_areas (ready) or reason (rejected). The typed photo mockup render
events carry mockup_id, result_url, a public {error_code, message} failure
when applicable, and optional export_format / duration_ms. Event types:
render.succeeded, render.failed, upload.succeeded, video.succeeded,
video.failed, photo_mockup.ready, photo_mockup.rejected,
photo_mockup.failed, photo_mockup_render.succeeded,
photo_mockup_render.failed, seam_fix.succeeded, seam_fix.failed,
webhook.test. Seam fix deliveries carry result_url and alternative_url.
The five photo mockup events also have a legacy spelling: 2d_mockup.ready,
2d_mockup.rejected, 2d_mockup.failed, 2d_render.succeeded,
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) 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.
Logs
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_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
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 trial, and every render it makes is watermarked and capped at 1,024 px. It can keep 5 PSD templates, run one render at a time, and a template that has gone 13 days without a render is removed.
Funding the balance lifts all of it at once. The watermark and the width cap come off, stored templates go to 150, renders run 25 at a time alongside 10 concurrent uploads, and templates stop being removed for sitting idle.
Trial is not a separate plan. It is the unfunded state of the pay-as-you-go tier, so
get_account reports the same tier before and after funding; the balance is what
changes.
Because of that, an account paying as it goes has no monthly allowance, and
get_account reports credits_limit and credits_remaining as 0 while the
account is perfectly able to pay. Read prepaid_balance alongside them, or read
funding_summary, which states both in one line and never reports a funded account
as 0 / 0.
Example requests
- "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"
- "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"
- "Check this pattern tile for seams, fix it if needed, then render it on the leggings mockup"
- "Animate the hoodie mockup into a 5-second video clip"
- "Upload this PSD as a new template: https://example.com/mockup.psd"
- "Set up a webhook at https://example.com/hooks so I get notified when renders finish"
- "How many credits do I have left?"
Links
- Dashboard -- Manage mockups and API keys
- API Docs -- Full REST API reference
- Pricing
- Status -- Service uptime
License
MIT
SudoMock MCP questions
How do I add SudoMock MCP to Claude Code?
Run claude mcp add --env 'SUDOMOCK_API_KEY=<YOUR_SUDOMOCK_API_KEY>' mcp-server -- npx -y @sudomock/mcp in your terminal. Add --scope user to make it available in every project.
How do I add SudoMock MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does SudoMock MCP provide?
It exposes 51 tools, including list_mockups, get_mockup_details, update_mockup, delete_mockup, render_mockup.
How do I authenticate with SudoMock?
You authenticate using your SUDOMOCK_API_KEY provided as an environment variable in your MCP client.
Can I use this server with Claude or Cursor?
Yes, the server is designed to work with Claude, Cursor, Windsurf, and VS Code.
Does the server support remote HTTP/OAuth transport?
No, currently only a local stdio server is available.
How long do background removal URLs last?
The transparent-PNG cutout URLs provided by the background removal tool are available for 7 days.