@dynamic-mockups/mcp 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +45 -124
  2. package/package.json +1 -1
  3. package/src/index.js +1 -1
package/README.md CHANGED
@@ -1,92 +1,15 @@
1
1
  # Dynamic Mockups MCP Server
2
2
 
3
- Official MCP (Model Context Protocol) server for the [Dynamic Mockups API](https://dynamicmockups.com). Generate product mockups directly from AI assistants like Claude, Cursor, Windsurf, and more.
3
+ Official MCP server for [Dynamic Mockups](https://dynamicmockups.com) — a product mockup generator API. Create professional mockups directly from AI assistants like Claude, Cursor, and Windsurf.
4
4
 
5
- ## Installation
6
-
7
- ### Quick Start with npx
8
-
9
- No installation required - just configure your MCP client:
10
-
11
- ```json
12
- {
13
- "mcpServers": {
14
- "dynamic-mockups": {
15
- "command": "npx",
16
- "args": ["-y", "@dynamic-mockups/mcp"],
17
- "env": {
18
- "DYNAMIC_MOCKUPS_API_KEY": "your_api_key_here"
19
- }
20
- }
21
- }
22
- }
23
- ```
24
-
25
- ### Get Your API Key
26
-
27
- 1. Go to [Dynamic Mockups Dashboard](https://app.dynamicmockups.com/account/api-keys)
28
- 2. Create a new API key
29
- 3. Add it to your MCP client configuration
30
-
31
- ## Configuration by Client
32
-
33
- ### Claude Desktop
34
-
35
- Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
36
-
37
- ```json
38
- {
39
- "mcpServers": {
40
- "dynamic-mockups": {
41
- "command": "npx",
42
- "args": ["-y", "@dynamic-mockups/mcp"],
43
- "env": {
44
- "DYNAMIC_MOCKUPS_API_KEY": "your_api_key_here"
45
- }
46
- }
47
- }
48
- }
49
- ```
50
-
51
- ### Claude Code (CLI)
52
-
53
- Add to `.mcp.json` in your project root:
54
-
55
- ```json
56
- {
57
- "mcpServers": {
58
- "dynamic-mockups": {
59
- "command": "npx",
60
- "args": ["-y", "@dynamic-mockups/mcp"],
61
- "env": {
62
- "DYNAMIC_MOCKUPS_API_KEY": "your_api_key_here"
63
- }
64
- }
65
- }
66
- }
67
- ```
68
-
69
- ### Cursor
5
+ ## Requirements
70
6
 
71
- Add to `.cursor/mcp.json` in your project:
72
-
73
- ```json
74
- {
75
- "mcpServers": {
76
- "dynamic-mockups": {
77
- "command": "npx",
78
- "args": ["-y", "@dynamic-mockups/mcp"],
79
- "env": {
80
- "DYNAMIC_MOCKUPS_API_KEY": "your_api_key_here"
81
- }
82
- }
83
- }
84
- }
85
- ```
7
+ - Node.js 18 or higher
8
+ - Dynamic Mockups API key — [get one here](https://app.dynamicmockups.com/dashboard-api)
86
9
 
87
- ### Windsurf
10
+ ## Installation
88
11
 
89
- Add to `~/.codeium/windsurf/mcp_config.json`:
12
+ Add the following to your MCP client configuration file:
90
13
 
91
14
  ```json
92
15
  {
@@ -102,56 +25,53 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
102
25
  }
103
26
  ```
104
27
 
105
- ## Available Tools
106
-
107
- ### API Information
108
- - **`get_api_info`** - Get API knowledge base (billing, rate limits, formats, best practices, support)
109
-
110
- ### Catalogs
111
- - **`get_catalogs`** - Retrieve all available catalogs
112
-
113
- ### Collections
114
- - **`get_collections`** - Retrieve collections (optionally filter by catalog)
115
- - **`create_collection`** - Create a new collection
116
-
117
- ### Mockups
118
- - **`get_mockups`** - Get list of available mockups with optional filters
119
- - **`get_mockup_by_uuid`** - Retrieve a specific mockup by UUID
120
-
121
- ### Rendering
122
- - **`create_render`** - Create a single mockup render with design assets
123
- - **`create_batch_render`** - Render multiple mockups in one request
124
- - **`export_print_files`** - Export print files for smart objects
125
-
126
- ### PSD Files
127
- - **`upload_psd`** - Upload a PSD file with optional mockup template creation
128
- - **`delete_psd`** - Delete a PSD file with optional related mockups deletion
28
+ ### Config File Locations
29
+
30
+ | Client | Config File Path |
31
+ |--------|------------------|
32
+ | Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` |
33
+ | Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` |
34
+ | Claude Code (CLI) | `.mcp.json` in project root |
35
+ | Cursor | `.cursor/mcp.json` in project |
36
+ | Windsurf | `~/.codeium/windsurf/mcp_config.json` |
37
+
38
+ ## Tools
39
+
40
+ | Tool | Description |
41
+ |------|-------------|
42
+ | `get_api_info` | Get API knowledge base (billing, rate limits, formats, best practices, support) |
43
+ | `get_catalogs` | Retrieve all available catalogs |
44
+ | `get_collections` | Retrieve collections (optionally filter by catalog) |
45
+ | `create_collection` | Create a new collection |
46
+ | `get_mockups` | Get list of available mockups with optional filters |
47
+ | `get_mockup_by_uuid` | Retrieve a specific mockup by UUID |
48
+ | `create_render` | Create a single mockup render with design assets (1 credit) |
49
+ | `create_batch_render` | Render multiple mockups in one request (1 credit per image) |
50
+ | `export_print_files` | Export high-resolution print files for production |
51
+ | `upload_psd` | Upload a PSD file and optionally create a mockup template |
52
+ | `delete_psd` | Delete a PSD file with optional related mockups deletion |
129
53
 
130
54
  ## Usage Examples
131
55
 
132
- ### Get Your Catalogs
133
-
134
56
  Ask your AI assistant:
135
- > "Get my Dynamic Mockups catalogs"
136
-
137
- ### Get Mockups from a Collection
138
-
139
- > "Show me all mockups in my T-shirt collection"
140
-
141
- ### Create a Render
142
-
143
- > "Create a mockup render using mockup UUID abc123 with my logo from https://example.com/logo.png"
144
-
145
- ### Batch Render
146
57
 
147
- > "Render my design on all mockups in the Summer collection"
58
+ | Use Case | Example Prompt |
59
+ |----------|----------------|
60
+ | List catalogs | "Get my Dynamic Mockups catalogs" |
61
+ | Browse mockups | "Show me all mockups in my T-shirt collection" |
62
+ | Single render | "Create a mockup render using any T-shirt mockup with my artwork from url: https://example.com/my-design.png" |
63
+ | Batch render | "Render my artwork from url: https://example.com/my-design.png on all mockups in the Winter T-shirt collection" |
64
+ | Create collection | "Create a new collection called Summer 2025 Hoodies" |
65
+ | Upload PSD | "Upload my PSD mockup from url: https://example.com/my-mockup.psd and create a template from it" |
66
+ | API info | "What are the rate limits and supported file formats for Dynamic Mockups?" |
67
+ | Print files | "Export print-ready files at 300 DPI for my poster mockup" |
148
68
 
149
69
  ## Development
150
70
 
151
71
  ### Local Installation
152
72
 
153
73
  ```bash
154
- git clone https://github.com/dynamicmockups/mcp-server.git
74
+ git clone https://github.com/dynamic-mockups/mcp.git
155
75
  cd mcp-server
156
76
  npm install
157
77
  ```
@@ -196,8 +116,9 @@ The server returns clear error messages for common issues:
196
116
 
197
117
  - [Dynamic Mockups Website](https://dynamicmockups.com)
198
118
  - [API Documentation](https://docs.dynamicmockups.com)
199
- - [Get API Key](https://app.dynamicmockups.com/account/api-keys)
200
- - [GitHub Issues](https://github.com/dynamicmockups/mcp-server/issues)
119
+ - [Get API Key](https://app.dynamicmockups.com/dashboard-api)
120
+ - [GitHub Repository](https://github.com/dynamic-mockups/mcp)
121
+ - [GitHub Issues](https://github.com/dynamic-mockups/mcp/issues)
201
122
 
202
123
  ## License
203
124
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynamic-mockups/mcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Official Dynamic Mockups MCP Server - Generate product mockups with AI assistants",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
package/src/index.js CHANGED
@@ -99,7 +99,7 @@ function validateApiKey() {
99
99
  "API key not configured",
100
100
  {
101
101
  solution: "Set the DYNAMIC_MOCKUPS_API_KEY environment variable in your MCP client configuration.",
102
- get_key_at: "https://app.dynamicmockups.com/account/api-keys",
102
+ get_key_at: "https://app.dynamicmockups.com/dashboard-api",
103
103
  }
104
104
  );
105
105
  }