Skip to main content
Glama

add_viewmodel

Append a UMVVM view model context to a Widget Blueprint's MVVM authoring state, specifying its view model class, context name, and creation type.

Instructions

Append a UMVVMViewModelContext to a Widget BP's MVVM authoring state.

Returns: { widget_blueprint_name, view_model_class, context_name, creation_type, source_property_path?, global_identifier?, already_existed, view_model_count, has_mvvm_extension }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNoOptional. This command is REFUSED while a Play-in-Editor session is running: it either compiles a Blueprint (the reinstancer can retain a world, and CheckForWorldGCLeaks is Fatal -- it KILLS the editor) or writes to disk (Editor.AllowSavingAssetsDuringPIE=0 makes the engine refuse the write, so it would report success without writing a byte). Stop PIE and retry instead; force=true runs it anyway, at your own risk.
context_nameYesFName identifying this context (idempotency key)
creation_typeNoOptional (default "CreateInstance"): one of "CreateInstance" | "PropertyPath" | "GlobalViewModelCollection" | "Manual" (EMVVMBlueprintViewModelContextCreationType).
view_model_classYesView model class: asset path (/Game/...) or /Script/<Module>.<ClassName>
global_identifierNoOptional: only used when creation_type="GlobalViewModelCollection" (required in that case). Sets FMVVMBlueprintViewModelContext::GlobalViewModelIdentifier.
source_property_pathNoOptional: only used when creation_type="PropertyPath" (required in that case). Sets FMVVMBlueprintViewModelContext::ViewModelPropertyPath.
widget_blueprint_nameYes/Game path of the Widget Blueprint asset (string)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnly=false, destructive=false, openWorld=false, so safety is covered; the description adds the non-obvious return shape (already_existed, view_model_count, has_mvvm_extension), which is real behavioral value given no output schema. However it omits failure modes such as the PIE-session refusal and the on-disk save implication, so it is only partially transparent. There is also mild tension with idempotentHint=false, since an "already_existed" return implies repeat-call stability.

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

Conciseness5/5

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

Two sentences: the mutation is front-loaded, followed by a compact return declaration. Nothing is wasted, and the return list compensates for the absent output schema rather than padding.

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?

For a 7-parameter mutation on an asset's authoring state, the description covers what and returns but not when to prefer it, what happens on collision with an existing context, or any prerequisite/preconditions. It is adequate but leaves the selection and precondition gaps to the schema and annotations.

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 description coverage is 100% and the schema documents every parameter in depth, including the enum-like creation_type values and the conditional requirements for source_property_path/global_identifier. The description adds nothing beyond that, so the baseline of 3 applies.

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?

States a specific verb and resource: "Append a UMVVMViewModelContext" to a Widget Blueprint's MVVM authoring state. The scope is unambiguous, but the description never distinguishes this from the closely related siblings remove_viewmodel, set_viewmodel_field, or bind_widget_to_viewmodel, so an agent must infer which one applies.

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?

No when-to-use, when-not-to-use, or alternatives are stated. The only conditional guidance (the PIE refusal and force flag) lives in the schema for the force parameter, not in the description. An agent gets no routing help toward remove_viewmodel or the binding tools.

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