pixellab-forge-mcp 1.4.0 → 1.4.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.
- package/README.md +32 -3
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -13,6 +13,8 @@ Generated images are automatically saved to `./pixellab-forge-output/` in your p
|
|
|
13
13
|
|
|
14
14
|
No installation needed. `npx` downloads and runs the package automatically on first use.
|
|
15
15
|
|
|
16
|
+
> **Package registry:** `pixellab-forge-mcp` is published to the public [npm registry (npmjs.org)](https://www.npmjs.com/package/pixellab-forge-mcp) — that's what `npx`/`npm install` use. It is **not** distributed via GitHub Packages, so the repo's `/pkgs/npm/…` page will 404; that's expected.
|
|
17
|
+
|
|
16
18
|
### Claude Code (CLI)
|
|
17
19
|
|
|
18
20
|
```bash
|
|
@@ -80,7 +82,7 @@ Add this to your `.gitignore`:
|
|
|
80
82
|
pixellab-forge-output/
|
|
81
83
|
```
|
|
82
84
|
|
|
83
|
-
## Available Tools (
|
|
85
|
+
## Available Tools (66)
|
|
84
86
|
|
|
85
87
|
Generation tools automatically poll for results — no manual job status checking needed. If a job takes longer than 10 minutes or the connection drops, use `list_pending_jobs` to find the job ID and `get_job_status` to retrieve the result.
|
|
86
88
|
|
|
@@ -91,17 +93,28 @@ Generation tools automatically poll for results — no manual job status checkin
|
|
|
91
93
|
| `generate_image` | Generate pixel art from text | `reference_images`, `style_image`, `style_options`, `no_background`, `seed` |
|
|
92
94
|
| `generate_with_style` | Match style from 1-4 references | `style_images`, `style_description`, `no_background`, `seed` |
|
|
93
95
|
| `generate_ui` | Game UI elements (buttons, panels, icons) | `concept_image`, `color_palette`, `no_background`, `seed` |
|
|
96
|
+
| `create_image_pixen` | Pixen engine (max area 512×512, dims ÷4) | `outline`, `detail`, `view`, `direction`, `no_background`, `enhance_prompt`, `seed` |
|
|
94
97
|
| `create_image_pixflux` | Pixflux engine (32-400px) | `text_guidance_scale`, `init_image`, `color_image`, `no_background`, `isometric`, `outline/shading/detail`, `seed` |
|
|
98
|
+
| `create_image_pixflux_background` | Pixflux engine tuned for backgrounds/scenes | Same as `create_image_pixflux` |
|
|
95
99
|
| `create_image_bitforge` | Bitforge engine (max 200px) | `text_guidance_scale`, `style_image`, `inpainting_image`, `mask_image`, `color_image`, `skeleton_keypoints`, `outline/shading/detail`, `seed` |
|
|
96
100
|
|
|
97
101
|
### Characters & Objects
|
|
98
102
|
|
|
99
103
|
| Tool | Description | Key Options |
|
|
100
104
|
|------|-------------|-------------|
|
|
105
|
+
| `create_character_v3` | Character via v3 model (32-256px, newest) | `reference_image` (rotate exact character) or text-only, `view`, `template_id`, `outline`, `detail`, `enhance_prompt`, `no_background`, `seed` |
|
|
106
|
+
| `create_character_pro` | Character/object via Pro engine (32-168px) | `method` (style/concept/rotate), `concept_image`, `reference_image`, `style_description`, `view`, `template_id`, `no_background`, `seed` |
|
|
101
107
|
| `create_character_4dir` | Character with N/S/E/W views | `proportions`, `view`, `text_guidance_scale`, `outline/shading/detail`, `color_image`, `force_colors`, `template_id`, `isometric`, `seed` |
|
|
102
108
|
| `create_character_8dir` | Character with 8 directional views | Same as 4dir |
|
|
103
|
-
| `
|
|
104
|
-
| `
|
|
109
|
+
| `create_character_state` | New state/variant of a saved character | `character_id`, `edit_description`, `use_color_palette_from_reference`, `no_background`, `seed` |
|
|
110
|
+
| `animate_character` | Animate saved character (template only) | `template_animation_id` (walking, fireball, breathing-idle, etc. — [47 templates](docs/prompting-guide.md#animation-templates)), `action_description`, `directions`, `outline/shading/detail`, `seed` |
|
|
111
|
+
| `create_character_animation` | Animate saved character (template/v3/pro) | `character_id`, `mode`, `template_animation_id`, `action_description`, `frame_count`, `directions`, `seed` |
|
|
112
|
+
| `create_object_1dir` | Object, single direction (32-256px) | `size`, `view` (top-down/sidescroller), `style_images`, `item_descriptions` |
|
|
113
|
+
| `create_object_8dir` | Object with 8 directional views (32-256px) | `size`, `view`, `reference_image` (rotate exact) or `style_image` (new in style) |
|
|
114
|
+
| `animate_object` | Animate a saved object | `object_id`, `mode` (v3/pro), `animation_description`, `directions`, `frame_count`, `custom_start_frame`, `end_frame`, `enhance_prompt` |
|
|
115
|
+
| `create_object_state` | New state/variant of a saved object | `object_id`, `edit_description`, `seed` |
|
|
116
|
+
| `select_object_frames` | Keep specific candidate frames as objects | `object_id`, `indices`, `common_tag` |
|
|
117
|
+
| `dismiss_object_review` | Accept an object as-is (clear review) | `object_id` |
|
|
105
118
|
| `list_characters` / `list_objects` | List with pagination | `limit`, `offset` |
|
|
106
119
|
| `get_character` / `get_object` | Get details by ID | |
|
|
107
120
|
| `delete_character` / `delete_object` | Delete by ID | |
|
|
@@ -126,6 +139,7 @@ Generation tools automatically poll for results — no manual job status checkin
|
|
|
126
139
|
| Tool | Description | Key Options |
|
|
127
140
|
|------|-------------|-------------|
|
|
128
141
|
| `generate_8_rotations` | 8 directional views (32-168px) | `method` (rotate/style/concept), `view`, `style_description`, `no_background`, `seed` |
|
|
142
|
+
| `generate_8_rotations_v3` | 8 rotations from one frame (v3) | `first_frame`, `no_background`, `seed` |
|
|
129
143
|
| `rotate` | Rotate between views/directions | `from_view/to_view`, `from_direction/to_direction`, `view_change`, `direction_change`, `image_guidance_scale`, `isometric`, `seed` |
|
|
130
144
|
|
|
131
145
|
### Editing & Inpainting
|
|
@@ -142,6 +156,7 @@ Generation tools automatically poll for results — no manual job status checkin
|
|
|
142
156
|
| Tool | Description | Key Options |
|
|
143
157
|
|------|-------------|-------------|
|
|
144
158
|
| `image_to_pixelart` | Convert photo to pixel art | `image`, `output_size` |
|
|
159
|
+
| `image_to_pixelart_pro` | Convert photo to pixel art (Pro, auto-sizes) | `image`, `description`, `seed` |
|
|
145
160
|
| `resize_image` | AI-powered pixel art resize | `reference_image`, `target_size`, `color_image` |
|
|
146
161
|
| `remove_background` | Remove background (max 400px) | `background_removal_task`, `text_hint` |
|
|
147
162
|
|
|
@@ -154,6 +169,7 @@ Generation tools automatically poll for results — no manual job status checkin
|
|
|
154
169
|
| `create_isometric_tile` | Isometric tile (16-64px) | `isometric_tile_shape` (block/thick/thin), `text_guidance_scale`, `outline/shading/detail`, `color_image`, `seed` |
|
|
155
170
|
| `create_tiles_pro` | Pro tiles (hex, iso, octagon, square) | `tile_type`, `tile_size`, `tile_view`, `tile_depth_ratio`, `style_images`, `style_options`, `n_tiles`, `seed` |
|
|
156
171
|
| `get_tileset` / `get_isometric_tile` / `get_tiles_pro` | Retrieve by ID | |
|
|
172
|
+
| `list_tilesets` / `list_isometric_tiles` | List with pagination | `limit`, `offset` |
|
|
157
173
|
|
|
158
174
|
### Map Objects
|
|
159
175
|
|
|
@@ -161,6 +177,16 @@ Generation tools automatically poll for results — no manual job status checkin
|
|
|
161
177
|
|------|-------------|-------------|
|
|
162
178
|
| `create_map_object` | Game-ready object | `view`, `outline/shading/detail`, `text_guidance_scale`, `background_image`, `inpainting`, `color_image`, `seed` |
|
|
163
179
|
|
|
180
|
+
### Prompt Enhancement
|
|
181
|
+
|
|
182
|
+
Expand a short description into a richer prompt. These return enhanced **text only** — they do not generate images.
|
|
183
|
+
|
|
184
|
+
| Tool | Description | Key Options |
|
|
185
|
+
|------|-------------|-------------|
|
|
186
|
+
| `enhance_character_prompt` | Enrich a prompt for `create_character_v3` | `description`, `image_size`, `view`, `outline`, `detail` |
|
|
187
|
+
| `enhance_animation_prompt` | Enrich a motion prompt for `animate_with_text_v3` | `first_frame`, `action`, `last_frame` |
|
|
188
|
+
| `enhance_pixen_prompt` | Enrich a prompt for `create_image_pixen` | `description`, `image_size`, `outline`, `detail`, `view`, `direction`, `no_background` |
|
|
189
|
+
|
|
164
190
|
### Account & Jobs
|
|
165
191
|
|
|
166
192
|
| Tool | Description |
|
|
@@ -169,6 +195,7 @@ Generation tools automatically poll for results — no manual job status checkin
|
|
|
169
195
|
| `get_job_status` | Check a background job by ID |
|
|
170
196
|
| `list_pending_jobs` | List jobs that haven't completed (for recovery after disconnection) |
|
|
171
197
|
| `list_job_history` | Recent job history (auto-pruned after 24h) |
|
|
198
|
+
| `read_image` | Load a saved PNG as a Base64 image to pass into other tools |
|
|
172
199
|
|
|
173
200
|
### Common Options
|
|
174
201
|
|
|
@@ -273,6 +300,8 @@ Set `PIXELLAB_API_KEY` in the inspector's environment variables, connect, and te
|
|
|
273
300
|
|
|
274
301
|
Contributions are welcome via pull requests.
|
|
275
302
|
|
|
303
|
+
Maintainers: see [RELEASING.md](RELEASING.md) for the release process.
|
|
304
|
+
|
|
276
305
|
## License
|
|
277
306
|
|
|
278
307
|
MIT
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pixellab-forge-mcp",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.1",
|
|
4
4
|
"description": "MCP server for the PixelLab pixel art generation API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"bin": {
|
|
8
|
-
"pixellab-forge-mcp": "
|
|
8
|
+
"pixellab-forge-mcp": "dist/index.js"
|
|
9
9
|
},
|
|
10
10
|
"files": [
|
|
11
11
|
"dist"
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
],
|
|
31
31
|
"repository": {
|
|
32
32
|
"type": "git",
|
|
33
|
-
"url": "https://github.com/rabbitcannon/pixellab-forge-mcp.git"
|
|
33
|
+
"url": "git+https://github.com/rabbitcannon/pixellab-forge-mcp.git"
|
|
34
34
|
},
|
|
35
35
|
"engines": {
|
|
36
36
|
"node": ">=18.0.0"
|