Skip to main content
Glama

export_spritesheet

Destructive

Combine animation frames into a single sprite-sheet image, controlling layout, scaling, padding, and optional JSON metadata for game engines.

Instructions

Export frames into a single sprite-sheet image.

Args:
    output: Destination sheet image (.png).
    sheet_type: one of horizontal, vertical, rows, columns, packed.
    scale: Integer upscaling factor.
    data_output: Optional .json path to also write frame/tag/slice metadata
        (JSON-array format) describing each frame's rectangle in the sheet.
    padding: Pixels of padding around/between frames.
    layer: Only include this layer.
    ignore_layer: Exclude this layer (e.g. a "reference" layer).
    split_layers: Lay out each layer as separate cels in the sheet.
    split_tags: Treat each tag as a separate set in the sheet.
    overwrite: Replace existing output(s) (default False = no-clobber). When
        data_output is given, both files are checked before anything is written.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
layerNo
scaleNoDefault: 1.
outputYes
paddingNoDefault: 0.
filenameYes
overwriteNoDefault: false.
sheet_typeNoDefault: "packed".packed
split_tagsNoDefault: false.
data_outputNo
ignore_layerNo
split_layersNoDefault: false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed27 schema fields changedv0.10.0
    • removedInput schema / properties / data_output / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / data_output / default
      Removed value: -null
    • removedInput schema / properties / data_output / title
      Removed value: -"Data Output"
    • addedInput schema / properties / data_output / type
      Added value: +"string"
    • removedInput schema / properties / filename / title
      Removed value: -"Filename"
    • removedInput schema / properties / ignore_layer / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / ignore_layer / default
      Removed value: -null
    • removedInput schema / properties / ignore_layer / title
      Removed value: -"Ignore Layer"
    • addedInput schema / properties / ignore_layer / type
      Added value: +"string"
    • removedInput schema / properties / layer / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / layer / default
      Removed value: -null
    • removedInput schema / properties / layer / title
      Removed value: -"Layer"
    • addedInput schema / properties / layer / type
      Added value: +"string"
    • removedInput schema / properties / output / title
      Removed value: -"Output"
    • addedInput schema / properties / overwrite / description
      Added value: +"Default: false."
    • removedInput schema / properties / overwrite / title
      Removed value: -"Overwrite"
    • addedInput schema / properties / padding / description
      Added value: +"Default: 0."
    • removedInput schema / properties / padding / title
      Removed value: -"Padding"
    • addedInput schema / properties / scale / description
      Added value: +"Default: 1."
    • removedInput schema / properties / scale / title
      Removed value: -"Scale"
    • addedInput schema / properties / sheet_type / description
      Added value: +"Default: \"packed\"."
    • removedInput schema / properties / sheet_type / title
      Removed value: -"Sheet Type"
    • addedInput schema / properties / split_layers / description
      Added value: +"Default: false."
    • removedInput schema / properties / split_layers / title
      Removed value: -"Split Layers"
    • addedInput schema / properties / split_tags / description
      Added value: +"Default: false."
    • removedInput schema / properties / split_tags / title
      Removed value: -"Split Tags"
    • removedInput schema / title
      Removed value: -"export_spritesheetArguments"
  2. First observedv0.7.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the description carries less burden. It still adds real value beyond them: the no-clobber default (overwrite=False), and the guarantee that when data_output is given 'both files are checked before anything is written,' which is meaningful write-safety context not expressible in annotations.

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-loads the purpose in one sentence, then organizes per-argument notes in a consistent docstring style. Essentially every line carries information; only a little verbosity in the overwrite/split entries, but nothing wasted.

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?

For an 11-parameter, destructive export tool with no output schema, the description covers nearly all parameters plus the write-safety semantics. It could still note the return value (paths written) or interaction with split_layers/split_tags and data_output, but it is close to complete.

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?

Schema coverage is only 55%, but the description compensates: it enumerates the valid sheet_type values (horizontal, vertical, rows, columns, packed) that the schema lacks as an enum, explains the data_output JSON-array format, and gives an example for ignore_layer. Only filename goes undocumented, a minor gap.

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

Purpose4/5

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

States a specific verb and resource: 'Export frames into a single sprite-sheet image.' That is clear and unambiguous. However, it never distinguishes this tool from close siblings like export_spritesheet_packed, export_frames, or export_png, so an agent cannot route between them on the description alone.

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

Usage Guidelines2/5

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

The description is purely mechanical (what each arg does); it gives no when-to-use context, no prerequisites, and no mention of alternatives despite several overlapping export siblings. An agent gets no help deciding when this tool is the right choice versus export_spritesheet_packed.

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

Deploy Server

Other Tools