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
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | ||
| region | No | ||
| max_size | No | ||
| image_index | No |