Skip to main content
Glama

unreal_add_widget_to_viewport

Adds a widget instance to the Unreal Engine viewport so AI clients can display UI elements in the editor.

Instructions

Add a widget instance to the viewport.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "params": "<params>"
    },
    "name": "unreal_add_widget_to_viewport"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.3/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden and delivers almost nothing: no indication of what happens on success (does the widget render immediately? is it added to a viewport slot?), what happens if the widget is already in the viewport, whether it is persistent/reversible, or whether a viewport/editor context must be active. The output schema is declared, but the interaction semantics of this mutation remain undisclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single short sentence, front-loaded with the verb and free of padding, so nothing is wasteful. However, the brevity is achieved by omission rather than economy — there is no second sentence to resolve the widget-identification ambiguity.

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

Completeness3/5

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

The existence of an output schema reduces what the description must say about return values, and it is a single-parameter tool, so the bar is not extremely high. Still, with zero annotation coverage and a wholly undocumented parameter object, an agent cannot construct a valid call (or know a valid widget must exist first) from this definition alone.

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

Parameters1/5

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

There is one required parameter, 'params', with 0% schema description coverage and no properties enumerated, so it is a completely opaque blob. The description adds nothing — it doesn't say whether params carries a widget name, class path, widget instance reference, or viewport target/position. This is the exact case where the description must compensate for the schema and it does not.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The verb 'Add' and resource 'widget instance' plus destination 'viewport' are stated, but the sentence essentially restates the tool name and never clarifies the key distinction an agent needs: whether this instantiates a new widget or places an already-created widget (e.g., from unreal_add_widget / unreal_create_widget_blueprint) into the viewport. Which widget is affected and how it is identified is left entirely open.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no precondition (must the widget already exist?), and no reference to alternatives such as unreal_add_widget or unreal_remove_widget. The agent must infer the entire workflow context from the tool name alone.

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