Skip to main content
Glama

set_component_parameter_override

DestructiveIdempotent

Set a per-instance override for a single StateTree root parameter on a placed actor's UStateTreeComponent, replacing the asset default at runtime; clear overrides or auto-bind a tree when needed.

Instructions

Override a single UStateTree root parameter on a UStateTreeComponent living on a placed actor. CRITICAL: the implementation calls UStateTreeStateTreeReference::SetPropertyOverridden(ParamGuid, true) — without this, the runtime reads from the asset default and the per-instance value is silently dropped. The value is written via FInstancedPropertyBag::SetValueSerializedString so the engine parses the string into the parameter's actual type (Bool/Int/Float/Vector/Struct/...). The tree must already declare the parameter; add it with add_tree_parameter first. Use clear_overrides=true to remove the override (asset default takes over again) without writing a value. If the component has no bound tree, pass state_tree_path to auto-bind before overriding (cold-start convenience); the public UStateTreeComponent::SetStateTree(UStateTree*) handles the bind through reflection on the protected StateTreeRef member.

Returns: { actor_label, component_class, parameter_name, parameter_id, value, was_overridden, cleared, saved, bound_tree }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
valueYesOptional string-encoded value; type-driven by the parameter's FPropertyBagPropertyDesc
actor_labelYesActor label/name that owns the UStateTreeComponent (resolved against the editor world)
parameter_nameYesRoot parameter name to override (must exist on the bound tree)
clear_overridesNoIf true, drop all per-instance overrides on the component (asset defaults take over); value is ignored
state_tree_pathNoOptional path to a UStateTree to bind the component to if no tree is already bound

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, and the description adds substantial beyond-that context: the CRITICAL note that without SetPropertyOverridden the runtime silently reads the asset default and drops the per-instance value, that the string is parsed into the real property type, and that clear_overrides reverts to the asset default. This is exactly the kind of silent-failure disclosure the annotations cannot carry.

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?

The purpose and critical constraint are front-loaded and every sentence relates to behavior. It is dense with engine internals (SetPropertyOverridden, FInstancedPropertyBag::SetValueSerializedString, reflection on the protected StateTreeRef member), which adds length but mostly supports the failure-mode warning rather than padding.

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?

For a 5-parameter mutation tool with no output schema, the description covers prerequisites, the alternative clear mode, the auto-bind path, and enumerates the return fields. An agent has everything needed to invoke it correctly and interpret the result.

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

Parameters4/5

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

Schema coverage is already 100%, but the description still adds meaning beyond it: the type-driven string encoding of value, the 'value is ignored' behavior of clear_overrides, and the auto-bind semantics of state_tree_path. It goes past the baseline by explaining the mechanism rather than restating the schema.

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

Purpose5/5

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

The description opens with a specific verb+resource: 'Override a single UStateTree root parameter on a UStateTreeComponent living on a placed actor.' It distinguishes itself from the closest sibling by explicitly stating the parameter 'must already declare... add it with add_tree_parameter first', so an agent can route correctly without opening either schema.

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

Usage Guidelines4/5

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

It gives clear prerequisites ('tree must already declare the parameter; add it with add_tree_parameter first'), a mutually exclusive mode (clear_overrides=true drops overrides instead of writing a value), and a cold-start convenience (pass state_tree_path to auto-bind). It stops short of a full when-not comparison against other parameter-setting siblings like set_tree_parameter, so it is strong but not exhaustive.

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