muse-app-preview-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 (2) hide show
  1. package/README.md +85 -24
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,57 +1,118 @@
1
1
  # MUSE App Preview MCP
2
2
 
3
- MCP server for managing app store preview screenshots with MUSE Preview Maker.
3
+ [![npm version](https://badge.fury.io/js/muse-app-preview-mcp.svg)](https://www.npmjs.com/package/muse-app-preview-mcp)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ MCP (Model Context Protocol) server for managing App Store preview screenshots. Collect screenshots with titles during app development, then batch generate beautiful preview images.
4
7
 
5
8
  ## Features
6
9
 
7
- - **add_preview** - Add screenshot + title + subtitle as a preview set
8
- - **list_previews** - List all saved preview sets
9
- - **remove_preview** - Remove a specific preview
10
- - **update_preview** - Update an existing preview
11
- - **clear_all** - Clear all previews
12
- - **open_app** - Open MUSE Preview Maker app
13
- - **generate_previews** - Generate all preview images
14
- - **get_settings** / **update_settings** - Manage default settings
10
+ | Tool | Description |
11
+ |------|-------------|
12
+ | `add_preview` | Add a screenshot with title and subtitle as a preview set |
13
+ | `list_previews` | List all saved preview sets |
14
+ | `remove_preview` | Remove a specific preview by ID |
15
+ | `update_preview` | Update an existing preview set |
16
+ | `clear_all` | Clear all saved previews |
17
+ | `open_app` | Open MUSE Preview Maker app |
18
+ | `generate_previews` | Generate all preview images at once |
19
+ | `get_settings` | Get current default settings |
20
+ | `update_settings` | Update default device type, palette, output directory |
15
21
 
16
22
  ## Installation
17
23
 
24
+ ### Using Claude Code
25
+
18
26
  ```bash
19
- # Using Claude Code
20
27
  claude mcp add muse-app-preview-mcp npx muse-app-preview-mcp
28
+ ```
21
29
 
22
- # Or install globally
30
+ ### Global Installation
31
+
32
+ ```bash
23
33
  npm install -g muse-app-preview-mcp
24
34
  ```
25
35
 
26
36
  ## Usage
27
37
 
28
- ### Add Preview Sets
38
+ ### 1. Add Preview Sets
39
+
40
+ While developing your app, capture screenshots and save them as preview sets:
29
41
 
30
42
  ```
31
- Use add_preview tool:
32
- - screenshotPath: "/path/to/screenshot.png"
33
- - title: "Amazing Feature"
34
- - subtitle: "Discover new possibilities"
43
+ add_preview:
44
+ screenshotPath: "/path/to/screenshot.png"
45
+ title: "Amazing Feature"
46
+ subtitle: "Discover new possibilities"
47
+ deviceType: "iphone_6_7" # optional
48
+ paletteId: "ocean" # optional
35
49
  ```
36
50
 
37
- ### Generate Previews
51
+ ### 2. List Saved Previews
38
52
 
39
53
  ```
40
- Use generate_previews tool to create all preview images.
41
- The MUSE Preview Maker app will open and process all saved sets.
54
+ list_previews
55
+ ```
56
+
57
+ ### 3. Generate All Previews
58
+
59
+ When ready, generate all App Store preview images at once:
60
+
61
+ ```
62
+ generate_previews:
63
+ outputDirectory: "/path/to/output" # optional
64
+ exportAllSizes: true # optional
42
65
  ```
43
66
 
44
67
  ## Workflow
45
68
 
46
- 1. While developing an app, capture screenshots
47
- 2. Use `add_preview` to save each screenshot with title/subtitle
48
- 3. Repeat for all preview screens
49
- 4. Use `generate_previews` to create all App Store preview images
69
+ ```
70
+ ┌─────────────────────────────────────────────────────────────┐
71
+ │ During App Development with Claude Code │
72
+ │ │
73
+ │ 1. Capture screenshot of Feature A │
74
+ │ → add_preview with title "Feature A" │
75
+ │ │
76
+ │ 2. Capture screenshot of Feature B │
77
+ │ → add_preview with title "Feature B" │
78
+ │ │
79
+ │ 3. Capture screenshot of Feature C │
80
+ │ → add_preview with title "Feature C" │
81
+ │ │
82
+ │ 4. Ready to submit to App Store │
83
+ │ → generate_previews │
84
+ │ → All preview images created! │
85
+ └─────────────────────────────────────────────────────────────┘
86
+ ```
87
+
88
+ ## Supported Devices
89
+
90
+ - iPhone 6.7" (1290 x 2796)
91
+ - iPhone 6.5" (1284 x 2778)
92
+ - iPhone 5.5" (1242 x 2208)
93
+ - iPad Pro 12.9" (2048 x 2732)
94
+ - Mac (2880 x 1800)
95
+ - Apple Watch 45mm (396 x 484)
96
+ - Android Phone (1080 x 1920)
97
+ - Android Tablet (1200 x 1920)
98
+
99
+ ## Color Palettes
100
+
101
+ - `ocean` - Blue to Cyan gradient
102
+ - `sunset` - Orange to Pink gradient
103
+ - `forest` - Green to Teal gradient
104
+ - `lavender` - Purple to Pink gradient
105
+ - `midnight` - Dark blue to Purple gradient
106
+ - `coral` - Coral to Orange gradient
50
107
 
51
108
  ## Requirements
52
109
 
53
110
  - Node.js 18+
54
- - MUSE Preview Maker app (macOS/iOS)
111
+ - MUSE Preview Maker app (macOS) - for image generation
112
+
113
+ ## Related
114
+
115
+ - [MUSE Preview Maker](https://github.com/MUSE-CODE-SPACE/muse-preview-maker) - macOS app for creating App Store preview images
55
116
 
56
117
  ## License
57
118
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "muse-app-preview-mcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "MCP server for managing app store preview screenshots with MUSE Preview Maker",
5
5
  "main": "dist/index.js",
6
6
  "bin": {