Skip to main content
Glama
gimp-mcp-studio
by Onru-Labs

get_state_snapshot

Capture a live PNG preview of the current GIMP canvas without saving files, giving AI agents immediate visual feedback to verify edits and decide next steps.

Instructions

Return a live visual snapshot of the current image state — no file save needed.

AI agents call this to get immediate visual feedback after any edit operation, letting them verify results and decide next steps without saving to disk.

Parameters:

  • image_index: Which open image to snapshot (default: 0 = most recent)

  • max_size: Maximum width/height of the returned preview in pixels (default: 512)

  • region: Optional dict {x, y, width, height} to zoom into a specific area e.g. {"x": 200, "y": 300, "width": 100, "height": 80} for mouth area

  • label: Optional annotation label (logged but not drawn — for agent bookkeeping)

Returns:

  • PNG image of the current GIMP canvas state (with alpha if present)

Typical agent workflow: 1. open_image / new_canvas 2. 3. get_state_snapshot() ← see result, decide next step 4. 5. get_state_snapshot(region={"x":200,"y":300,"width":100,"height":80}) 6. export_image when satisfied

Input Schema

NameRequiredDescriptionDefault
labelNo
regionNo
max_sizeNo
image_indexNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does reasonably well: it discloses that nothing is written to disk, that the return is a PNG of the live canvas including alpha, and a non-obvious behavioral detail that 'label' is logged but not drawn. It does not state that the call is side-effect-free/read-only, nor any cost or performance characteristics of returning a 512px raster.

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?

It is front-loaded with the one-line purpose, then parameters, returns and workflow, so an agent can stop reading early. There is mild redundancy between 'no file save needed' and 'without saving to disk', and the Returns/Parameters blocks partly restate schema defaults.

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 a zero-required-parameter read tool with no output schema, the description supplies purpose, full parameter semantics, the return format, and a realistic call sequence — enough to invoke it correctly. The remaining gap is sibling positioning against get_image_bitmap and a clear statement that the operation is non-mutating.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate, and it does: every one of the four parameters is explained beyond its schema type, including that image_index 0 means 'most recent', that max_size bounds both width and height in pixels, and a concrete region example. The label semantics ('logged but not drawn') correct a plausible misreading an agent would otherwise make from the bare 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?

The first sentence states a specific verb and resource: 'Return a live visual snapshot of the current image state', and adds a scoping fact ('no file save needed') that separates it from export_image. It does not explicitly distinguish itself from the sibling get_image_bitmap, which appears to serve a similar visual-retrieval purpose, so differentiation is incomplete.

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?

The 'AI agents call this to get immediate visual feedback after any edit operation' line plus the 6-step typical workflow give a concrete when-to-use context, including the zoomed-region inspection case. It stops short of any when-not guidance or named alternatives (e.g. when to prefer get_image_bitmap or export_image instead).

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