Skip to main content
Glama

set_audio_volume

DestructiveIdempotent

Set an audio component's volume multiplier in the Unreal Editor world by object name; values must be 0-10, and modulation limits reset to 1.

Instructions

Set VolumeMultiplier (0 to 10, else an error; also resets VolumeModulationMin/Max to 1) on an audio component of the editor world, matched by object name against the first audio component of each actor. No undo, no dirty mark. Returns old_volume, new_volume and volume_set.

Returns: { audio_component_name: string, old_volume: number, new_volume: number, requested_volume: number, volume_set: bool, volume_message: string, audio_enabled: bool, audio_pitch: number, audio_mobility: string, audio_sound_name: string, audio_3d_attenuation_radius: number, audio_position: { x, y, z }, audio_owner_name: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
volumeYesVolume multiplier between 0.0 and 10.0
audio_component_nameYesObject name of the audio component to modify (e.g. "AudioComponent0"), compared without case; only the first audio component of each actor is searched.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedInput schema / properties / audio_component_name / description
      Previous value: -"Name of the audio component to modify"New value: +"Object name of the audio component to modify (e.g. \"AudioComponent0\"), compared without case; only the first audio component of each actor is searched."
  2. First observedv1.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the mutation profile is partly covered. The description adds genuinely new behavioral context: no undo, no dirty mark, out-of-range values produce an error, and the call silently resets VolumeModulationMin/Max to 1. That side effect is the most valuable disclosure, though permission/auth requirements are not covered.

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-loaded with the core action and its side effect, then scoping, then safety notes. Slightly redundant: the first sentence previews the return values and a later sentence repeats them with full detail, which duplicates effort.

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?

With no output schema, the explicit returns listing is necessary and supplied. Range/error behavior, side effects, matching rule, and no-undo semantics are all covered. Missing only higher-level context such as which permissions are needed or which actors are searched.

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 the baseline is 3, but the description goes further by specifying that values outside 0-10 cause an error rather than clamping, and it restates the name-matching rule (first audio component per actor). That adds behavior the schema's type/range note does not convey.

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 names a specific verb+resource (set VolumeMultiplier on an audio component of the editor world) and pins down the matching semantics (object name against the first audio component of each actor). It also discloses the side effect on VolumeModulationMin/Max, so an agent knows exactly what changes. This is distinguishable from adjacent audio setters like set_audio_sound or set_sound_wave_properties.

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 explicit when-to-use guidance, no stated prerequisites, and no routing to an alternative tool despite many audio-related siblings. The 'editor world' scoping and name-matching rule imply usage context but do not tell the agent when this is the right call versus another volume/audio tool.

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