aseprite-ai-artist

Overview Schema Source Related Servers Discussions Admin

Reference image

reference

Import external images as locked, semi-transparent guide layers to trace proportions or sample colors; crop panels or split storyboard grids onto animation frames.

Instructions

Bring an external image into the sprite as a reference layer, so you can trace proportions or sample colours from it. Ops: 'import' (place an image on a locked, semi-transparent layer above the art), 'sample_palette' (read its dominant colours without importing), 'list', 'remove'. A concept sheet or storyboard arrives as one image: region crops one panel of it, and grid cuts it into panels and puts panel i on frame i of a single reference layer, so each animation frame is drawn over its own storyboard panel. Importing at a different size uses nearest-neighbour; a reference scaled down to 32×32 is a guide for proportion and pose, never a finished sprite.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`x`	No
`y`	No
`op`	Yes
`fit`	No	How to size the image (or each panel) against the canvas.	contain
`grid`	No	Import a storyboard: split the (cropped) source into equal panels and place panel i on frame `frame`+i-1 of one reference layer. The sprite must already have enough frames.
`name`	No	Layer name. Default: 'reference'.
`path`	No	Image file to read.
`frame`	No	Import: the frame the image — or the first `grid` panel — lands on. Default: the active frame, or frame 1 with `grid`.
`colors`	No	For 'sample_palette'.
`region`	No	Use only this rectangle of the SOURCE image, in its own pixels — one panel of a concept sheet. Applies to 'import' and 'sample_palette'.
`sprite`	No	Which sprite: its id as '#7' (what every result reports back, and the only unambiguous form — two unsaved documents are both called 'Sprite'), its filename, or its display name. Omit to use the sprite Aseprite has focused.
`opacity`	No

Output Schema

TableJSON Schema

Name	Required	Description
`op`	Yes
`layer`	No
`width`	No
`frames`	No	Import: the frames that received a reference cel.
`height`	No
`panels`	No	Import: how many panels were placed.
`sprite`	Yes
`palette`	No	Dominant colours with their share of the image.
`references`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv0.4.0Sep 30, 2026

changedInput schema / properties / fit / description

Previous value: -"How to size the image against the canvas."New value: +"How to size the image (or each panel) against the canvas."

addedInput schema / properties / frame

Added value: +{
+  "description": "Import: the frame the image — or the first `grid` panel — lands on. Default: the active frame, or frame 1 with `grid`.",
+  "exclusiveMinimum": 0,
+  "type": "integer"
+}

addedInput schema / properties / grid

Added value: +{
+  "additionalProperties": false,
+  "description": "Import a storyboard: split the (cropped) source into equal panels and place panel i on frame `frame`+i-1 of one reference layer. The sprite must already have enough frames.",
+  "properties": {
+    "columns": {
+      "exclusiveMinimum": 0,
+      "type": "integer"
+    },
+    "count": {
+      "description": "Panels actually used, read row-major. Default: columns × rows.",
+      "exclusiveMinimum": 0,
+      "type": "integer"
+    },
+    "gap": {
+      "default": 0,
+      "description": "Source pixels between panels.",
+      "minimum": 0,
+      "type": "integer"
+    },
+    "rows": {
+      "exclusiveMinimum": 0,
+      "type": "integer"
+    }
+  },
+  "required": [
+    "columns",
+    "rows"
+  ],
+  "type": "object"
+}

addedInput schema / properties / region

Added value: +{
+  "additionalProperties": false,
+  "description": "Use only this rectangle of the SOURCE image, in its own pixels — one panel of a concept sheet. Applies to 'import' and 'sample_palette'.",
+  "properties": {
+    "height": {
+      "exclusiveMinimum": 0,
+      "type": "integer"
+    },
+    "width": {
+      "exclusiveMinimum": 0,
+      "type": "integer"
+    },
+    "x": {
+      "minimum": 0,
+      "type": "integer"
+    },
+    "y": {
+      "minimum": 0,
+      "type": "integer"
+    }
+  },
+  "required": [
+    "x",
+    "y",
+    "width",
+    "height"
+  ],
+  "type": "object"
+}

addedOutput schema / properties / frames

Added value: +{
+  "description": "Import: the frames that received a reference cel.",
+  "items": {
+    "type": "integer"
+  },
+  "type": "array"
+}

addedOutput schema / properties / panels

Added value: +{
+  "description": "Import: how many panels were placed.",
+  "type": "integer"
+}

Changed1 schema field changedv0.1.6Sep 9, 2026

changedInput schema / properties / sprite / description

Previous value: -"Sprite filename or id. Omit to use the sprite Aseprite has focused."New value: +"Which sprite: its id as '#7' (what every result reports back, and the only unambiguous form — two unsaved documents are both called 'Sprite'), its filename, or its display name. Omit to use the sprite Aseprite has focused."

First observedv0.1.0Sep 8, 2026

TDQS

A4.3/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint=false and openWorldHint=false; the description adds real behavior: import lands on a locked, semi-transparent layer above the art; resizing uses nearest-neighbour; a 32×32 reference is a proportion guide, never a finished sprite; grid requires the sprite to already have enough frames. Missing specifics like whether 'remove' is reversible, but coverage is strong.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose, then the op list, then the storyboard/grid mechanism, then the scaling caveat. Dense and mostly waste-free, though the panel-index explanation is slightly elaborate for the space it consumes.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no explanation, and the description covers the four ops, region, and grid for a 12-param nested tool. Gaps remain around 'list'/'remove' semantics and the 'fit'/'opacity' parameters, but nothing critical to correct invocation is absent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 67% schema coverage and 12 params, the description meaningfully supplements the schema: 'region' crops one panel of the SOURCE image, 'grid' places panel i on frame i of one reference layer, and import's scaling behavior is explained. It does not unpack the 'fit' enum values (contain/cover/stretch) or 'colors'/'opacity' effects, which remains a gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States the specific resource (external image as reference layer) and enumerates the four ops ('import', 'sample_palette', 'list', 'remove') with a one-clause gloss of each. An agent can distinguish this from the sibling 'layer', 'palette', and 'look' tools without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear when-to-use context per op: 'sample_palette' reads colours 'without importing', 'region' handles a single panel of a concept sheet, 'grid' handles a storyboard. It never names an alternative tool (e.g. why not use 'palette' to sample colours), so it stops short of the 5 bar.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server