@sudomock/mcp 1.0.0 → 1.0.1

package/README.md

@@ -1,19 +1,23 @@
-# @sudomock/mcp
+# SudoMock MCP Server
 
-Official [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server for [SudoMock](https://sudomock.com) -- the mockup generation API that renders photorealistic product mockups from Photoshop PSD templates.
+> Generate photorealistic product mockups from Claude, Cursor, Windsurf, and VS Code.
 
-This is a local **stdio** MCP server. It runs as a subprocess of your AI editor and communicates with the SudoMock API over HTTPS.
+[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, and get CDN-hosted renders -- all through natural language.
 
-## Prerequisites
+## Quick Start
 
-- Node.js 18+
-- A SudoMock API key ([get one here](https://sudomock.com/dashboard/api-keys))
+### Option 1: Local (npx)
 
-## Installation
+```bash
+claude mcp add sudomock \
+  -e SUDOMOCK_API_KEY=sm_your_key_here \
+  -- npx -y @sudomock/mcp
+```
 
-### Claude Desktop
+Get your API key at [sudomock.com/dashboard/api-keys](https://sudomock.com/dashboard/api-keys).
 
-Add to your `claude_desktop_config.json`:
+<details>
+<summary>JSON config for other clients (Cursor, Windsurf, VS Code)</summary>
 
 ```json
 {
@@ -22,96 +26,74 @@ Add to your `claude_desktop_config.json`:
       "command": "npx",
       "args": ["-y", "@sudomock/mcp"],
       "env": {
-        "SUDOMOCK_API_KEY": "sm_your_key"
+        "SUDOMOCK_API_KEY": "sm_your_key_here"
       }
     }
   }
 }
 ```
 
-### Claude Code
+</details>
 
-```bash
-claude mcp add sudomock -- npx -y @sudomock/mcp
+### Option 2: Remote (OAuth)
 
-# Then set the environment variable:
-export SUDOMOCK_API_KEY="sm_your_key"
-```
+No API key needed. Your client opens a browser for login.
 
-### Cursor
+```bash
+claude mcp add --transport http sudomock https://mcp.sudomock.com
+```
 
-Add to your Cursor MCP settings (`.cursor/mcp.json`):
+<details>
+<summary>JSON config for other clients</summary>
 
 ```json
 {
   "mcpServers": {
     "sudomock": {
-      "command": "npx",
-      "args": ["-y", "@sudomock/mcp"],
-      "env": {
-        "SUDOMOCK_API_KEY": "sm_your_key"
-      }
+      "type": "http",
+      "url": "https://mcp.sudomock.com"
     }
   }
 }
 ```
 
-### VS Code
+</details>
 
-Add to your VS Code MCP settings (`.vscode/mcp.json`):
-
-```json
-{
-  "servers": {
-    "sudomock": {
-      "command": "npx",
-      "args": ["-y", "@sudomock/mcp"],
-      "env": {
-        "SUDOMOCK_API_KEY": "sm_your_key"
-      }
-    }
-  }
-}
-```
-
-## Available Tools
+## Tools
 
 | Tool | Description | Credits |
 |------|-------------|---------|
 | `list_mockups` | List your uploaded mockup templates | 0 |
-| `get_mockup_details` | Get full details of a mockup (smart object UUIDs, layers, dimensions) | 0 |
-| `update_mockup` | Rename a mockup template | 0 |
-| `delete_mockup` | Permanently delete a mockup template | 0 |
-| `render_mockup` | Render a mockup by placing artwork onto a PSD template | 1 |
+| `get_mockup_details` | Get smart object UUIDs, dimensions, blend modes | 0 |
+| `render_mockup` | Render a mockup with your artwork | 1 |
 | `ai_render` | AI-powered render without a PSD template | 5 |
-| `upload_psd` | Upload a PSD/PSB file as a new mockup template | 0 |
-| `get_account` | Get account info, credit balance, and usage stats | 0 |
-| `create_studio_session` | Create an embedded studio session for interactive editing | 0 |
-
-## Quick Start
-
-Once installed, ask your AI assistant:
-
-> "List my SudoMock mockups"
-
-> "Render my t-shirt mockup with this artwork: https://example.com/design.png"
+| `upload_psd` | Upload a Photoshop PSD/PSB template | 0 |
+| `get_account` | Check plan, credits, and usage | 0 |
+| `update_mockup` | Rename a mockup template | 0 |
+| `delete_mockup` | Delete a mockup template | 0 |
+| `create_studio_session` | Create an embedded editor session | 0 |
 
-> "Check my SudoMock credit balance"
+## Example Prompts
 
-> "Upload this PSD as a new mockup template: https://example.com/mockup.psd"
+- "List my mockup templates"
+- "Render the t-shirt mockup with this design: https://example.com/logo.png"
+- "Upload this PSD as a new template: https://example.com/mockup.psd"
+- "How many credits do I have left?"
 
-The typical workflow is:
+## Resources
 
-1. `list_mockups` - find your mockup template UUID
-2. `get_mockup_details` - find the smart object UUID within the template
-3. `render_mockup` - render with your artwork URL
-4. `get_account` - check remaining credits
+The server provides built-in documentation:
 
-## API Reference
+- **Quick Start Guide** -- How to use the tools step by step
+- **Pricing** -- Live plan and credit information
+- **Formats** -- Supported output formats, blend modes, and PSD requirements
 
-Base URL: `https://api.sudomock.com`
+## Links
 
-Full API documentation: [sudomock.com/docs](https://sudomock.com/docs)
+- [Dashboard](https://sudomock.com/dashboard) -- Manage mockups and API keys
+- [API Docs](https://sudomock.com/docs) -- Full REST API reference
+- [Pricing](https://sudomock.com/pricing)
+- [Status](https://sudomock.statuspage.io) -- Service uptime
 
 ## License
 

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@sudomock/mcp",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "mcpName": "io.github.sudomock/mcp",
   "description": "SudoMock MCP server for Claude, Cursor, and VS Code. Generate photorealistic product mockups from Photoshop PSD templates.",
   "keywords": [
     "mcp",