SudoMock MCP Server
Connect Claude, Cursor, VS Code, Windsurf, and ChatGPT to your SudoMock account. Render photorealistic product mockups directly from your AI assistant.
The Model Context Protocol (MCP) lets AI assistants call external tools. SudoMock's MCP server gives your AI assistant direct access to mockup rendering, template management, and account info, so you can generate mockups with natural language instead of writing API calls.
Two Connection Methods
mcp.sudomock.com with browser-based auth. No API key needed. Local (npx) runs a local MCP process using your API key. Both connection methods require network access to SudoMock. Local mode can also be used in CI/CD pipelines.
https://mcp.sudomock.comQuick Start
Paste this prompt into Codex, Claude Code, or another coding assistant. It connects your account and checks that the tools are available before you start rendering.
Fetch the SudoMock setup instructions from https://sudomock.com/agent-setup/prompt.md and help me connect this client. Keep my current task and existing configuration. Verify the connection before continuing my task.
Remote (OAuth)
The fastest way to connect. Your AI client opens a browser window for authentication. No API key required.
1claude mcp add --transport http sudomock https://mcp.sudomock.com
Local (npx)
Runs a local MCP process that communicates over stdio. Requires an API key.
1claude mcp add sudomock \2 -e SUDOMOCK_API_KEY=sm_your_key \3 -- npx -y @sudomock/mcp
Get Your API Key
Supported Clients
SudoMock MCP works with all major AI coding assistants. Click a client below to jump to its setup instructions.
Platform Setup
Each section below shows both remote (OAuth) and local (API key) options. Pick one method per platform.
Codex
1codex mcp add sudomock --url https://mcp.sudomock.com2codex mcp login sudomock
Complete sign-in in your browser. Then ask Codex to check your SudoMock account with get_account. A successful connection confirms access; it does not create a mockup.
Claude Code
1# Remote (OAuth) - no API key needed2claude mcp add --transport http sudomock https://mcp.sudomock.com34# Local (npx) - requires API key5claude mcp add sudomock \6 -e SUDOMOCK_API_KEY=sm_your_key \7 -- npx -y @sudomock/mcp
Claude Desktop
Add to your Claude Desktop config file (claude_desktop_config.json):
1{2 "mcpServers": {3 "sudomock-remote": {4 "type": "http",5 "url": "https://mcp.sudomock.com"6 },7 "sudomock-local": {8 "command": "npx",9 "args": ["-y", "@sudomock/mcp"],10 "env": {11 "SUDOMOCK_API_KEY": "sm_your_key"12 }13 }14 }15}
Cursor
Or add manually to .cursor/mcp.json in your project root:
1{2 "mcpServers": {3 "sudomock-remote": {4 "type": "http",5 "url": "https://mcp.sudomock.com"6 },7 "sudomock-local": {8 "command": "npx",9 "args": ["-y", "@sudomock/mcp"],10 "env": {11 "SUDOMOCK_API_KEY": "sm_your_key"12 }13 }14 }15}
VS Code
Or add manually to .vscode/mcp.json in your workspace:
1{2 "servers": {3 "sudomock-remote": {4 "type": "http",5 "url": "https://mcp.sudomock.com"6 },7 "sudomock-local": {8 "command": "npx",9 "args": ["-y", "@sudomock/mcp"],10 "env": {11 "SUDOMOCK_API_KEY": "sm_your_key"12 }13 }14 }15}
ChatGPT
In ChatGPT settings, add the MCP server URL. ChatGPT handles OAuth automatically.
1# In ChatGPT settings, add this URL as an MCP server:2https://mcp.sudomock.com34# ChatGPT handles OAuth automatically.5# No API key needed.
Windsurf
Add to your Windsurf MCP configuration file (~/.codeium/windsurf/mcp_config.json):
1{2 "mcpServers": {3 "sudomock-remote": {4 "type": "http",5 "url": "https://mcp.sudomock.com"6 },7 "sudomock-local": {8 "command": "npx",9 "args": ["-y", "@sudomock/mcp"],10 "env": {11 "SUDOMOCK_API_KEY": "sm_your_key"12 }13 }14 }15}
Which method to choose?
Available Tools
The MCP server exposes 27 tools in 6 categories. Each tool links to its full API documentation. Credit costs are the same as calling the REST API directly: management and read operations are free, and video is priced from the model and duration rather than at a flat rate.
Rendering
Generate product mockups from templates or product photos.
| Tool | Description | Credits |
|---|---|---|
| render_mockup | Render a PSD mockup with required artwork and one Smart Object, plus an optional text-layer override. Returns one rendered image URL. | 1 |
| render_2d_mockup | Render one image from a saved photo mockup. Provide mockup_uuid, artwork_url, and exactly one surface_uuid or print_area_uuid from get_2d_mockup_details. The maximum output dimension is image_size. | 5 |
| render_video | Turn a mockup or a public image URL into a short product video. Always async: returns a job_id. | varies |
| remove_background | Turn any image into a transparent PNG cutout. The returned URL stays valid for 7 days and can be used as artwork. | 25 |
PSD Templates and Files
Upload, browse, rename, and delete your PSD mockup templates.
| Tool | Description | Credits |
|---|---|---|
| create_upload_url | Get a single-file upload URL for a local PSD or artwork. PUT the file bytes to upload_url, then pass file_url to the relevant tool. | 0 |
| list_fonts | List the system fonts and your uploaded fonts for editable text layers, with family and scope filters. | 0 |
| upload_psd | Upload a PSD or PSB file as a new mockup template. Requires at least one visible Smart Object or text layer; hosted render_mockup still requires a Smart Object. | 0 |
| list_mockups | List your uploaded templates with UUIDs, names, and thumbnails. | 0 |
| get_mockup_details | Get full details: smart object UUIDs, layer names, dimensions, positions, blend modes. | 0 |
| update_mockup | Rename a mockup template. | 0 |
| delete_mockup | Permanently delete a mockup template. Cannot be undone. | 0 |
Photo Mockups
Build reusable mockups from a product photo, then render any design onto them.
| Tool | Description | Credits |
|---|---|---|
| create_2d_mockup | Create a reusable photo mockup from a public image URL. Charged once per mockup, not per render, and refunded if the image is unsuitable. | 25 |
| list_2d_mockups | List your saved photo mockups with id, name, status, thumbnail, dimensions, and print areas. | 0 |
| get_2d_mockup_details | Get one photo mockup in full, including every printable product surface and the print areas saved on them. | 0 |
| update_2d_print_areas | Replace a mockup's print areas with up to 8 four-point quads and return the updated geometry. | 0 |
| delete_2d_mockup | Permanently delete a photo mockup and all of its data. Cannot be undone. | 0 |
Jobs
Track async renders, videos, uploads, and 2D work.
Webhooks
Register endpoints for job completion events, then debug and replay deliveries.
| Tool | Description | Credits |
|---|---|---|
| create_webhook_endpoint | Register an endpoint SudoMock calls when async jobs finish. The signing secret is returned in full exactly once. | 0 |
| list_webhook_endpoints | List your endpoints with id, url, subscribed event types, and enabled state. Secrets are never returned here. | 0 |
| delete_webhook_endpoint | Permanently delete an endpoint. Deliveries stop. Cannot be undone. | 0 |
| rotate_webhook_secret | Rotate an endpoint's signing secret. The new secret is returned in full exactly once and the old one stops working. | 0 |
| send_webhook_test_event | Send a signed webhook.test event to verify reachability and signature handling. | 0 |
| list_webhook_deliveries | List delivery attempts with status, event type, response code, and timestamps. | 0 |
| replay_failed_webhook_deliveries | Requeue failed or dead webhook deliveries for one endpoint. Check delivery records for the outcome. | 0 |
| replay_webhook_delivery | Replay a single delivery while preserving its event identity, for example after fixing your endpoint. | 0 |
Account
Check your plan, credit balance, and usage.
| Tool | Description | Credits |
|---|---|---|
| get_account | Get your account info: plan, credit balance, usage stats, billing period, API key details. | 0 |
Use Cases
Here are common workflows you can accomplish with the MCP server. Just type these prompts into your AI assistant.
| Use Case | Example Prompt |
|---|---|
| E-commerce product launch | “Render my logo on all t-shirt mockups in WebP format” |
| Print-on-demand automation | “Upload this PSD and render with my design at 2x size” |
| Brand asset generation | “Put my new branding on every hoodie and mug mockup” |
| Quick product photo | “Use Photo Mockups to place my artwork on this product photo” |
| Template management | “Show me all my mockups and delete the ones named "Old Template"” |
| Credit monitoring | “How many credits do I have left? What plan am I on?” |
Example Prompts
Once connected, talk to your AI assistant naturally. Here are some things you can say:
Repeated renders
render_mockup tool call per output and can repeat those calls in one conversation. The MCP server has no native batch render tool. For example: “Put my design on all t-shirt and hoodie mockups and give me the URLs.”Built-in Resources & Prompts
The MCP server includes built-in documentation and guided workflows that your AI assistant can read automatically.
Resources (Documentation)
| URI | Description |
|---|---|
docs://quickstart | Quick start guide for the SudoMock API and MCP tools |
docs://pricing | Pricing and credit information supplied by the MCP server |
docs://formats | Supported output formats, input requirements, and blend modes |
docs://errors | Error codes, permanent and transient failures, and retry guidance |
Prompts (Guided Workflows)
| Prompt | Description |
|---|---|
render_product_mockups | Create a PSD mockup using artwork and a template with a Smart Object. |
create_2d_mockup | Create a mockup from a product photo, then place artwork on it. |
troubleshoot_render | Check inputs, credits and the current job when diagnosing a render issue. |
Authentication
The remote server at mcp.sudomock.com supports two authentication methods:
sm_ API key via the x-api-key header or Authorization: Bearer header. Used by the local npx transport.Security Best Practices
.env files locally and add them to .gitignore.render_mockup = 1 credit, render_2d_mockup = 5 credits). Check your balance anytime with get_account before repeated render calls.Links
MCP server vs REST SDKs
@sudomock/mcp on npm and run with npx. It is a different package from the REST SDKs: the sudomock npm package (npmjs.com/package/sudomock) and the sudomock PyPI package (pypi.org/project/sudomock), which cover renders, async, video, jobs, and webhooks directly from your code.