Skip to main content
Glama

capture_pie_screenshot

Destructive

Capture a PNG of the Unreal Engine game or active editor viewport while omitting the UMG/Slate HUD. Optionally include a cropped HUD during Play-In-Editor that overwrites the image a frame later.

Instructions

Write a PNG of the game viewport (else the active editor viewport) from a synchronous ReadPixels, which omits the UMG/Slate HUD; returns output_path, width, height and bytes_written. With include_ui=true during PIE, a cropped HUD version overwrites output_path a frame later (ui_overwrite_next_frame).

Returns: { saved_to_pie_active, output_path, width, height, bytes_written, includes_ui, ui_overwrite_next_frame, ui_note? }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
include_uiNoWhen true and PIE is running with rendering, also request an engine screenshot with the HUD that a later frame crops to the game viewport (editor chrome removed) and writes over output_path; SDR only, given up after 8 s. Default false.
output_pathNoOptional string. If empty, auto-names into <Project>/Saved/MCP/PIE_<utc>.png.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • addedInput schema / properties / include_ui / description
      Added value: +"When true and PIE is running with rendering, also request an engine screenshot with the HUD that a later frame crops to the game viewport (editor chrome removed) and writes over output_path; SDR only, given up after 8 s. Default false."
  2. First observedv1.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Adds real behavioral context beyond the annotations: the write is destructive to output_path, and with include_ui=true a cropped HUD frame overwrites the file one frame later (ui_overwrite_next_frame), so the final file is not what a naive caller expects. It also discloses the synchronous ReadPixels path omits UMG/Slate HUD. It does not mention auth/permission needs or the 8s give-up limit (that lives in the schema).

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?

Front-loaded with the core action, then the conditional HUD caveat, then the return shape. Dense and technical but every clause carries information; the trailing 'Returns:' block partially repeats the first sentence's enumerated outputs but is justified since no output schema exists.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description supplies the return keys, the destructive write target, the HUD omission, and the delayed-overwrite hazard — everything an agent needs to call it correctly and reason about the resulting file. Both parameters are fully covered.

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

Parameters3/5

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

Schema coverage is 100%, so the schema already documents both parameters, including the 8s SDR-only timeout and auto-naming rule. The description's include_ui explanation largely restates the schema's own description of the same overwrite behavior, adding little beyond what is already structured.

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?

Names a precise verb and resource ('Write a PNG of the game viewport (else the active editor viewport)') plus the mechanism (synchronous ReadPixels) and the HUD exclusion. An agent can tell this is a PIE/editor screenshot capture, distinct from sibling capture_viewport or high_res_screenshot, though neither sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The include_ui paragraph describes a conditional path during PIE, which implies the usage context, and the parenthetical '(else the active editor viewport)' implies the non-PIE fallback. However, there is no explicit when-to-use/when-not guidance and no routing to the similar sibling capture tools, leaving the agent to infer.

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

Deploy Server

Other Tools