capture_screenshot
Capture a PNG screenshot of the running Unity Editor or game to visually verify that user-facing changes render correctly. Use it as the final proof step after read-state probes.
Instructions
capture_screenshot tool. Read-only. No token.
PERF 2026-05-25: mode parameter controls payload shape.
full(default, unchanged behavior): base64 PNG in response.metadata: sha256 + sizeBytes only — saves the ~2MB base64 from the LLM context. Caller can re-request withfullif needed.file_ref: persist PNG toUNITY_MCP_SCREENSHOT_DIRkeyed by sha256 and return the file path. For local agents that need the bytes without paying for them in token context.
Wall-clock cost is dominated by Unity-side CaptureScreenshot (~300ms,
two-tick delay + PNG encode); mode does not change that. The win is on
the LLM payload side.
FINAL-VERIFICATION ROLE: the final verification of any user-facing change MUST include a screenshot from this tool showing the expected result — read-state probes (lua_eval / logs / assertions) do not by themselves prove the change works. If the change spans multiple screens, capture one per meaningful step. When unsure the game is on the relevant screen, ask the user before capturing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | full | |
| width | No | ||
| height | No | ||
| supersize | No | ||
| skip_if_unchanged | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||