Skip to main content
Glama

get_pixels

Read-only

Read pixel colors from a rendered Aseprite frame, all visible layers, or one layer as a legend or hex grid, including transparency, to inspect sprite graphics.

Instructions

Reads pixels of the rendered frame (all visible layers) or of one layer. Default format 'legend' returns rows of characters plus a legend of colors ('.' = transparent); 'hex' returns a grid of '#rrggbbaa' (null = transparent). Indexed sprites return palette indices.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rectNo
frameNo1-based frame number. Defaults to the active frame (or 1).
layerNoRead only this layer (default: the composited frame)
formatNo
spriteNoFile path, open tab title, or sprite id. Defaults to the active sprite (live). Batch mode needs a file path.
backendNoauto (default): live Aseprite if connected, else headless batch
maxPixelsNoSafety limit on area (default 16384)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuine behavioral detail about output shape (character rows + legend vs '#rrggbbaa' grid, transparency markers, indexed sprites returning palette indices), but says nothing about the maxPixels safety limit or failure conditions.

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?

Purpose is front-loaded in the first clause, and the format semantics follow in compact clauses. Every sentence carries information; the density is high with no filler.

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?

With no output schema, the description correctly takes on the burden of describing return values, which it does for both formats and for indexed sprites. For a 7-parameter, all-optional read tool this is close to complete, with only the maxPixels limit behavior left implicit.

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 71%, and the description meaningfully extends the 'format' enum by explaining what each mode returns (legend characters plus color legend with '.' = transparent; hex grid with null = transparent). It also clarifies composited-frame vs single-layer reading, though it leaves rect, frame, backend, and maxPixels to the schema.

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 ('Reads') and resource ('pixels'), and scopes it to the rendered frame across all visible layers or a single layer. The read counterpart to draw_pixels is distinguishable from the verb alone, though no sibling is named explicitly.

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?

Implies the read use case and offers a scope choice (whole frame vs one layer), but gives no explicit when-to-use vs alternatives like draw_pixels, get_cels, or render_preview, and no exclusions or prerequisites.

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