take_screenshot
Capture the running Godot viewport as a PNG and return an inline preview, full image, or saved path plus blank-frame stats to verify rendering.
Instructions
Save a PNG of the running viewport under .mcp/godot-runtime/screenshots/ (kept after stop_project). responseMode: preview (default; inline, fits default 960x540, max 1920x1080), full (inline PNG, for small text), path_only (no image). Returns: projectPath, path, size, stats {chromatic, dominant, distinct, likelyBlank} from the full PNG, so a blank frame shows without vision. warnings leads if stats is null or the image is too big to inline. Errors: no session, no frame rendered, bridge timeout.
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": "take_screenshot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeout | No | Timeout in milliseconds to wait for the screenshot, a whole number from 1 to 600000 (default: 10000); a value from 59001 to 60000 is refused, since the answer would not fit a client's 60s request timeout. Time spent waiting for the session queue comes off it, and a call left with under 2000 ms is refused with nothing sent. The game gives up on a frame that never renders after 5000 ms and reports that; a lower timeout expires first. | |
| responseMode | No | Response payload mode. "preview" returns a bounded inline preview plus paths (default). "full" returns the full inline PNG. "path_only" returns paths only. An image file over 3 MiB, or a full PNG that could not be decoded, is not inlined: the path is returned with a leading warning. | |
| previewMaxWidth | No | Width in pixels of the box the preview is fitted into when responseMode is "preview". Default: 960. Maximum: 1920; a larger value is clamped to it, not refused. Use responseMode "full" for the screenshot at its own size. | |
| previewMaxHeight | No | Height in pixels of the box the preview is fitted into when responseMode is "preview". Default: 540. Maximum: 1080; a larger value is clamped to it, not refused. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| size | No | ||
| stats | Yes | ||
| warnings | No | ||
| previewPath | No | ||
| previewSize | No | ||
| projectPath | Yes | ||
| responseMode | Yes |