MCP Tools Reference

Each tool available through the SpriteSynth MCP server is documented below with parameters, descriptions, and return values.

generate_image

Generate a pixel art image from a text description.

Parameters

Name	Type	Required	Description
`description`	string	Yes	Text description of the image to generate
`model`	string	No	AI model: `fast` (default), `slow`
`image_size`	string	No	Image size: `128x128`, `256x256` (default), `512x512`
`seed`	integer	No	Random seed for reproducible results

Example Usage

Generate a 32x32 pixel art sword with a blue gem

Returns

Generated asset with download URL
Asset ID for further operations

create_character

Create a character with directional sprites and animation states.

Parameters

Name	Type	Required	Description
`description`	string	Yes	Description of the character
`direction_count`	integer	No	Directions: `1`, `4` (default), or `8`
`states`	array	No	States to generate: `["idle", "walk", "run", "attack"]` (default: `["idle"]`)
`width`	integer	No	Sprite width in pixels (default: 32)
`height`	integer	No	Sprite height in pixels (default: 32)

Example Usage

Create a knight character with 4 directions and idle, walk, and attack states

Returns

Character with UUID
Generated sprite sheets for each state and direction
States with frame metadata

create_tileset

Create a tileset for game environments.

Parameters

Name	Type	Required	Description
`type`	string	Yes	Tileset type: `top_down`, `sidescroller`, `isometric`
`tile_size`	integer	No	Tile size in pixels: `16` (default), `32`, `64`
`description`	string	Yes	Description of the tileset style and contents
`tile_count`	integer	No	Number of tiles to generate (default: 16)

Example Usage

Create a top-down dungeon tileset with stone floors, walls, and door tiles at 16x16

Returns

Tileset with UUID
Individual tile assets
Metadata JSON with tile positions

create_object

Create a game object with states and directional sprites.

Parameters

Name	Type	Required	Description
`description`	string	Yes	Description of the object
`direction_count`	integer	No	Directions: `1` (default), `4`, or `8`
`states`	array	No	States: `["idle", "broken", "open", "active"]` (default: `["idle"]`)
`width`	integer	No	Sprite width in pixels (default: 16)
`height`	integer	No	Sprite height in pixels (default: 16)

Example Usage

Create a treasure chest object with idle, open, and broken states

Returns

Object with UUID
Sprite sheets for each state
State metadata with frame counts

animate_character

Add or update animations for an existing character.

Parameters

Name	Type	Required	Description
`character_id`	uuid	Yes	ID of the character to animate
`animation_type`	string	Yes	Animation type: `walk`, `run`, `attack`, `hurt`, `cast`, etc.
`description`	string	No	Additional description for the animation style
`frame_count`	integer	No	Number of frames (default: 6)

Example Usage

Add a running animation to my knight character

Returns

Updated character with new animation state
Sprite sheet for the new animation

edit_image

Edit an existing image using natural language instructions.

Parameters

Name	Type	Required	Description
`asset_id`	uuid	Yes	ID of the asset to edit
`instruction`	string	Yes	Natural language editing instruction

Example Usage

Add a red glow to the gem in asset abc-123

Returns

Edited asset with new download URL
Original asset is preserved

inpaint

Fill a region of an image with AI-generated content.

Parameters

Name	Type	Required	Description
`asset_id`	uuid	Yes	ID of the source image
`mask`	string	Yes	Asset ID of the mask image (white = area to inpaint)
`prompt`	string	Yes	Description of what to generate in the masked area

Example Usage

Inpaint the masked area of asset abc-123 with a cracked stone texture

Returns

Inpainted asset with new download URL
Original asset is preserved

export_assets

Export assets in a game engine format.

Parameters

Name	Type	Required	Description
`type`	string	Yes	Asset type: `character`, `tileset`, `object`
`ids`	array	Yes	Array of UUIDs to export
`format`	string	Yes	Format: `unity`, `godot`, `tiled`, `aseprite`, `generic`

Example Usage

Export my knight character in Unity format

Returns

Download URL for the ZIP file
Format-specific metadata

list_projects

List all projects for the authenticated user.

Parameters

None.

Example Usage

List my projects

Returns

Array of projects with UUIDs, names, and asset counts

list_characters

List all characters for the authenticated user.

Parameters

Name	Type	Required	Description
`project_id`	uuid	No	Filter by project UUID

Example Usage

List my characters

Returns

Array of characters with UUIDs, names, state counts, and thumbnails

Need help?

Join our Discord community for support and tips.

MCP Tools Reference

On this page