Skip to main content
Glama

add_reference_layer

Add a dimmed, locked reference layer to an Aseprite sprite so you can trace over guide art while keeping it out of exports.

Instructions

Add a dimmed, locked layer holding a reference image to trace over.

Args:
    image_file: The reference image/sprite.
    layer_name: Name for the new layer (default "reference").
    opacity: Layer opacity (0-255); dim it so your art stands out.
    scale_to_fit: Resize the reference to the canvas size (smooth).
    x, y: Placement when not scaling to fit.
    frame: Which existing frame to place the reference on (1-based). An
        out-of-range frame is rejected with the sprite's valid range.

Exclude this layer from exports with ignore_layer="<layer_name>".

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
xNoDefault: 0.
yNoDefault: 0.
frameNoDefault: 1.
opacityNoDefault: 128.
filenameYes
image_fileYes
layer_nameNoDefault: "reference".reference
scale_to_fitNoDefault: false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv0.10.0
    • removedInput schema / properties / filename / title
      Removed value: -"Filename"
    • addedInput schema / properties / frame / description
      Added value: +"Default: 1."
    • removedInput schema / properties / frame / title
      Removed value: -"Frame"
    • removedInput schema / properties / image_file / title
      Removed value: -"Image File"
    • addedInput schema / properties / layer_name / description
      Added value: +"Default: \"reference\"."
    • removedInput schema / properties / layer_name / title
      Removed value: -"Layer Name"
    • addedInput schema / properties / opacity / description
      Added value: +"Default: 128."
    • removedInput schema / properties / opacity / title
      Removed value: -"Opacity"
    • addedInput schema / properties / scale_to_fit / description
      Added value: +"Default: false."
    • removedInput schema / properties / scale_to_fit / title
      Removed value: -"Scale To Fit"
    • addedInput schema / properties / x / description
      Added value: +"Default: 0."
    • removedInput schema / properties / x / title
      Removed value: -"X"
    • addedInput schema / properties / y / description
      Added value: +"Default: 0."
    • removedInput schema / properties / y / title
      Removed value: -"Y"
    • removedInput schema / title
      Removed value: -"add_reference_layerArguments"
  2. First observedv0.7.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations declare the mutation/safety profile (readOnly=false, destructive=false, openWorld=false), and the description adds real behavioral context beyond them: the layer is dimmed and locked, the frame argument is validated with an out-of-range rejection, and the layer can be excluded from exports. It stops short of describing return values or lock semantics fully, warranting a 4.

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?

The core purpose is front-loaded in the first sentence, followed by an arg list that maps cleanly to parameters. Slightly verbose in enumerating defaults, but every line carries useful information.

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 8-parameter mutation tool with no output schema, the description covers behavior, most parameters, and a follow-up export note. The omission of the required 'filename' parameter keeps it from being fully 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 75%, and the description adds genuine meaning: opacity range 0-255 with dimming intent, scale_to_fit as smooth resize, x/y as placement only when not scaling, and frame as 1-based with rejection behavior. Only the required 'filename' parameter is left undocumented, so it falls just short of full compensation.

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 a specific verb (Add), resource (layer), and defining traits (dimmed, locked, holding a reference image to trace over). This clearly distinguishes it from generic siblings like add_layer or add_group_layer without needing to open 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 Guidelines3/5

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

The phrase 'to trace over' implies the intended use case, and the closing note gives a follow-up action (exclude via ignore_layer). However, no alternative tool is named and there is no explicit when-to-use/when-not guidance versus add_layer or import_reference_sequence.

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