Skip to main content
Glama

add_component_material_track

Adds or reuses a component material parameter track on a Level Sequence binding, keys a scalar parameter at a frame when provided, and saves the sequence.

Instructions

Adds a component material parameter track for one indexed material slot to an object binding of a Level Sequence (first asset-name match under /Game), or reuses the binding's existing track for that slot, and saves the sequence. With parameter_name it keys that scalar parameter at frame (a tick-resolution frame) and reads the key back: success requires it, and a key the engine would skip (locked section, read-only sequence) is refused before anything is written; without it, it only adds a section spanning the playback range when the track has none. The slot index is not checked against the bound component, which is not resolved. An unknown binding_guid or a material_index that is not a whole number >= 0 is an error. For a Material Parameter Collection use add_material_parameter_collection_track; for other animated properties use add_property_track.

Returns: { sequence_name: string, binding_guid: string, track_class: string, track_added: bool, material_index: int, material_type: string, parameter_name: string, value: number, key_added: bool (read back from the track), section_added: bool (the track gained a section, keying included), scalar_channel_count: int, section_count: int, saved: bool, save_error?: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
frameNoOptional frame number for the key (default 0)
valueNoOptional scalar value for the keyed parameter (default 0.0)
binding_guidYesGUID of the actor/component object binding to attach the material track to
sequence_nameYesName of the target Level Sequence
material_indexNoOptional indexed material slot the track animates, a whole number >= 0 (default 0)
parameter_nameNoOptional scalar material parameter name to key

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.2
    • changedInput schema / properties / material_index / description
      Previous value: -"Optional indexed material slot the track animates (default 0)"New value: +"Optional indexed material slot the track animates, a whole number >= 0 (default 0)"
  2. First observedv1.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations (which only declare the write/idempotency/safety profile), the description discloses substantial behavioral traits: the key is read back from the track for success, a key the engine would skip (locked section, read-only sequence) is refused before any write, the slot index is not validated against the bound component, and the sequence is saved. These are details annotations cannot convey.

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?

Purpose and scope are front-loaded, and the dense first sentence carries the core semantics. It is long and somewhat run-on, but for a tool with this many conditional behaviors most of the length earns its place; slight tightening would help readability.

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 compensates by enumerating the full return object (track_added, key_added read back, section_added, saved, save_error, etc.) plus error conditions and sibling alternatives. An agent has everything needed to call it 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 100%, so baseline is 3, but the description adds real meaning: 'frame' is clarified as tick-resolution, material_index must be a whole number >= 0 or it errors, and the slot index is not checked against the bound component. This goes beyond the schema's terse parameter blurbs.

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 states a precise verb+resource ('Adds a component material parameter track for one indexed material slot to an object binding of a Level Sequence') and even covers the reuse path when the track already exists. It explicitly names the sibling alternatives add_material_parameter_collection_track and add_property_track, so an agent can place it among the sequence-track tools without ambiguity.

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

Usage Guidelines5/5

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

It gives explicit conditional behavior: with parameter_name it keys a scalar parameter and reads back; without it, it only adds a section when the track has none. It also routes the agent to alternative tools for MPCs and other animated properties, which is exactly the when-to-use-this-vs-sibling guidance needed.

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