Skip to main content
Glama

set_audio_section_properties

DestructiveIdempotent

Configure playback properties on a Level Sequence audio section, including sound, looping, play-until-finished, subtitles, and attenuation overrides.

Instructions

Set playback properties on an audio section (UMovieSceneAudioSection). Optionally swaps the sound and toggles loop/play-until-finished/subtitle/attenuation flags. SetAttenuationSettings is a no-op at eval unless override_attenuation is true, so the override flag is applied first.

Returns: { sequence_path: string, section_class: string, section_index: int, sound: string, sound_set: bool, looping: bool, play_until_finished: bool, suppress_subtitles: bool, override_attenuation: bool, attenuation: string, attenuation_set: bool, set: bool, saved: bool, save_error?: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
loopingNoSection repeating/looping (maps to SetRepeating, the engine's loop knob; omit to leave unchanged).
sound_pathNoOptional content path of a USoundBase to set as the section's sound.
section_indexNoIndex of the section on the resolved root audio track (default 0).
sequence_nameNoAlias for sequence_path.
sequence_pathNoFull /Game path OR bare asset name of the Level Sequence that owns the (root) audio track.
attenuation_pathNoOptional content path of a USoundAttenuation to set (only effective when override_attenuation is true).
suppress_subtitlesNoSetSuppressSubtitles (omit to leave unchanged).
play_until_finishedNoSetPlayUntilFinished (omit to leave unchanged).
override_attenuationNoSetOverrideAttenuation; must be true for attenuation_path to take effect (omit to leave unchanged).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • removedInput schema / required
      Removed value: -[
      -  "sequence_path"
      -]
  2. First observedv1.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already supply destructiveHint=true and idempotentHint=true, but the description adds genuinely non-obvious behavior: that SetAttenuationSettings is a no-op at eval unless override_attenuation is true, requiring the override to be applied first. The Returns block also reveals that the call saves the asset (saved / save_error), telling the agent this has persistent side effects.

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-loads the purpose, then the key caveat, then the return shape, with no filler sentences. The Returns block is somewhat dense but earns its place given there is no output schema.

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

Completeness4/5

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

For a 9-parameter mutation tool with no output schema, the description covers the operation, the optional/omit semantics, the critical attenuation ordering constraint, and the response fields including save status. Only the explicit alternative-tool routing is missing.

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 each parameter is individually documented in the schema, so the baseline is 3. The description adds only the grouping of toggles and the override_attenuation ordering caveat, which largely restates what the schema's own parameter descriptions already say.

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 (set) and resource (playback properties on a UMovieSceneAudioSection), and enumerates the tunable fields (sound, loop, play-until-finished, subtitles, attenuation). It is clearly distinguishable from the read counterpart get_audio_section_properties, but it never names set_audio_sound or the other set_audio_* siblings even though 'optionally swaps the sound' overlaps with them.

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?

Usage is implied by the description ('Optionally swaps the sound and toggles...' with 'omit to leave unchanged' semantics carried by the schema). There is no explicit when-to-use-this vs set_audio_sound/set_audio_section_start_offset guidance and no stated preconditions such as needing the sequence loaded. The attenuation ordering note is the only routing-style hint.

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