screenshot
Capture images of the running Godot game or editor view for the agent to inspect, with optional crops, scaling, format control, and numbered UI annotations.
Instructions
Capture an image the agent can see. target=game (default) captures the RUNNING game; target=editor the editor's 2D or 3D view (PNG only). A bare call caps the long edge at max_dim=1280: pass scale, region, max_dim=0, format or save_to to opt out. annotate=ui draws numbered Set-of-Mark boxes and returns the legend. For pure functional state ui_snapshot is cheaper. Token dials, game pixels, delivery: help(tool="screenshot").
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "screenshot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scale | No | 0.05..1.0 downscale before encode (default 1.0) | |
| format | No | png (default) | jpeg | webp (game target) | |
| region | No | [x,y,w,h] pixel crop | |
| target | No | game | editor | |
| deliver | No | inline (default) | link (a capture:// resource_link, no base64) | both | |
| max_dim | No | long-edge cap in px (default 1280 on a bare call; 0 = no cap) | |
| quality | No | jpeg/webp quality 0.1..1.0 (default 0.8) | |
| save_to | No | also write the frame here (res://, user:// or absolute): a diff baseline | |
| annotate | No | ui = numbered marks on interactive controls + their legend (game target) | |
| viewport | No | SubViewport (or its container) path: its own game pixels, not the window | |
| max_marks | No | cap on annotate marks (default 40) |