Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

set_audio_bus_channels

DestructiveIdempotent

Change the channel layout of an existing UAudioBus asset, such as Mono or 5.1, and save it to update the bus. Use create_audio_bus to make a new bus instead.

Instructions

Change the channel layout (AudioBusChannels) of an existing UAudioBus asset and save it; success requires the save. Returns channels, channels_int and num_channels read back from the asset. To make a new bus use create_audio_bus.

Returns: { bus_path: string, asset_class: string, channels: string, channels_int: int, num_channels: int, saved: bool }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bus_pathYesAsset path of the UAudioBus, e.g. "/Game/Audio/AB_Music".
channelsYesEAudioBusChannels: 'Mono' | 'Stereo' | 'Quad' | 'FiveDotOne' | 'SevenDotOne', case-insensitive; FivePointOne, 5.1, SevenPointOne and 7.1 are accepted too.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.0
    • changedInput schema / properties / bus_path / description
      Previous value: -"Full content path of the target UAudioBus"New value: +"Asset path of the UAudioBus, e.g. \"/Game/Audio/AB_Music\"."
    • changedInput schema / properties / channels / description
      Previous value: -"EAudioBusChannels: 'Mono' | 'Stereo' | 'Quad' | 'FiveDotOne' | 'SevenDotOne'"New value: +"EAudioBusChannels: 'Mono' | 'Stereo' | 'Quad' | 'FiveDotOne' | 'SevenDotOne', case-insensitive; FivePointOne, 5.1, SevenPointOne and 7.1 are accepted too."
  2. First observedv1.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, readOnlyHint=false. The description adds real context beyond them: the change is persisted via the save and 'success requires the save', and it lists the fields read back from the asset. It stops short of permission/auth or rollback details.

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 save semantics, then the return shape and the sibling pointer. The return-type listing is slightly dense but justified since there is no output schema; each part carries information.

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 mutating two-parameter tool with no output schema, the description covers the save requirement and the return fields, and annotations cover the safety profile. It is largely complete, missing only permission/persistence-target nuance.

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%, with both bus_path and the channel enum values fully documented in the schema, so the baseline is 3. The description only restates the AudioBusChannels type, adding no syntax or format detail beyond 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?

States a specific verb (change), the exact resource (channel layout / AudioBusChannels of an existing UAudioBus asset), and the save-semantics. It also names the sibling create_audio_bus for the new-bus case, so an agent can distinguish it from siblings without opening a 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?

Explicitly routes agents creating a new bus to create_audio_bus, giving a when-not plus an alternative. It does not state prerequisites beyond 'existing' asset, but the usage context is clear.

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