Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

clear_usd_attribute

DestructiveIdempotent

Remove authored USD attribute values from a prim on an open stage; clear all samples and the default, or only the sample at a given time. Edits in memory; save_usd_stage writes the change.

Instructions

Clear authored values of a USD attribute on a prim of an open stage: with time, only the sample at that time code; without it, the default value and every time sample. Edits the stage in memory; save_usd_stage writes it. Returns present and cleared, present false when the attribute is missing.

Returns: { prim_path: string, attr_name: string, cleared: bool, present: bool, time: number? }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
timeNoTime code of the single sample to clear (ClearAtTime); omit it to clear the default value and all samples (Clear).
attr_nameYesName of the attribute to clear, e.g. "size".
prim_pathYesAbsolute SdfPath of an existing prim on that stage, e.g. "/World/Cube".
stage_nameYesName the stage was registered under by open_usd_stage (default the file basename) or create_usd_stage (default "Untitled").

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.2.0
    • changedInput schema / properties / attr_name / description
      Previous value: -"Attribute name"New value: +"Name of the attribute to clear, e.g. \"size\"."
    • changedInput schema / properties / prim_path / description
      Previous value: -"Target prim path"New value: +"Absolute SdfPath of an existing prim on that stage, e.g. \"/World/Cube\"."
    • changedInput schema / properties / stage_name / description
      Previous value: -"Stage cache key"New value: +"Name the stage was registered under by open_usd_stage (default the file basename) or create_usd_stage (default \"Untitled\")."
    • changedInput schema / properties / time / description
      Previous value: -"Optional time code; when omitted clears ALL times (Attr.Clear), when present clears just that time (Attr.ClearAtTime)"New value: +"Time code of the single sample to clear (ClearAtTime); omit it to clear the default value and all samples (Clear)."
  2. First observedv1.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Goes well beyond the annotations: annotations declare destructive/idempotent/not-read-only, and the description adds that the change is in-memory only and requires save_usd_stage to persist, plus that present=false signals a missing attribute. These are non-obvious behavioral facts an agent needs before calling.

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 and dense, with the time semantics stated first and persistence second. Slightly redundant, as the prose sentence and the 'Returns:' block both describe present/cleared, but both remain short and useful.

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?

No output schema exists, so the description carries the return-value burden and does so fully with an explicit shape. Combined with the mutation/persistence disclosure, nothing an agent needs to call this correctly 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%, so every parameter is already documented, including the time semantics and the stage_name registration detail. The description restates the time behavior in prose but adds no syntax or edge cases beyond the schema, so the baseline 3 is appropriate.

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 (clear) and resource (authored values of a USD attribute on a prim of an open stage), with precise scope: it clears authored values rather than the attribute itself, distinguishing it from sibling remove_usd_attribute. An agent can pick it apart from set_usd_attribute_value or get_usd_attribute_value immediately.

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?

Clearly explains the with-time vs without-time usage split (single sample vs default plus all samples) and that the edit is in-memory pending save_usd_stage. It does not explicitly name alternatives or exclusions, e.g. when to prefer remove_usd_attribute instead, so it stops short of full when/when-not guidance.

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