Skip to main content
Glama

create_sound_attenuation

Create or load a USoundAttenuation asset, force attenuation on, apply falloff distance and sphere radius, then save it for sound falloff in Unreal Engine.

Instructions

Create a USoundAttenuation asset at package_path/name, or load the one already there, then force bAttenuate on, apply the optional falloff_distance and sphere radius, and save it (re-running edits the existing asset). Returns the values read back; set_sound_attenuation_properties edits every other field.

Returns: { name: string, package_path: string, asset_path: string, asset_class: string, attenuate: bool, falloff_distance: number, radius: number, shape_extent_x: number, shape_extent_y: number, shape_extent_z: number, applied_falloff_distance: bool, applied_radius: bool, created: bool, already_exists: bool, saved: bool }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName of the new Sound Attenuation asset
radiusNoInner sphere radius in Unreal units (cm); sets the shape to Sphere and AttenuationShapeExtents to (radius, 0, 0). Unchanged when omitted.
package_pathNoTarget content path, defaults to /Game/Audio
falloff_distanceNoFalloffDistance in Unreal units (cm): how far beyond the inner shape the volume fades out. Unchanged when omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.0
    • changedInput schema / properties / falloff_distance / description
      Previous value: -"Optional FalloffDistance on FBaseAttenuationSettings"New value: +"FalloffDistance in Unreal units (cm): how far beyond the inner shape the volume fades out. Unchanged when omitted."
    • changedInput schema / properties / radius / description
      Previous value: -"Optional sphere radius applied to AttenuationShapeExtents X"New value: +"Inner sphere radius in Unreal units (cm); sets the shape to Sphere and AttenuationShapeExtents to (radius, 0, 0). Unchanged when omitted."
  2. First observedv1.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations it discloses real behavior: create-or-load upsert semantics, that bAttenuate is forced on, that only the optional falloff/radius are applied, that the asset is saved to disk, and that re-running edits rather than duplicates. Minor tension: this "re-running edits the existing asset" language implies repeat-call stability while idempotentHint is declared false, so the annotation and description are not perfectly aligned.

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 action and routing are front-loaded in the first sentence, and the second sentence covers return values, which is useful given there is no output schema. The raw field list in the Returns block is long and repetitive, but it is information-bearing rather than filler.

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 mutating asset-creation tool with no output schema, the description covers the critical gaps itself: upsert semantics, forced field values, save side effect, re-run behavior, sibling routing, and a full return-field list. Nothing essential for correct invocation 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 coverage is 100%, so the schema already defines radius, package_path and falloff_distance including the "unchanged when omitted" behavior. The description only restates that they are optional and describes package_path/name composition, adding little 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?

Specific verb ("Create") plus specific resource ("USoundAttenuation asset") with path construction detail, and it explicitly distinguishes itself from the sibling set_sound_attenuation_properties. An agent can identify the tool's job without opening the 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 names the alternative for the complementary case ("set_sound_attenuation_properties edits every other field"), which routes the agent correctly, and the upsert note explains the create-vs-rerun situation. It stops short of an explicit when-not-to-use or a pointer to the read-side sibling (get_sound_attenuation_properties).

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