Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

set_usd_prim_display_name

DestructiveIdempotent

Sets the displayName metadata (a UI label) on an existing USD prim at the current edit target without renaming the prim. Returns display_name and set; not saved to disk.

Instructions

Author the displayName metadata (a UI label; the prim name does not change) on an existing prim of a registered USD stage, at the current edit target. An empty string is written as an empty displayName, not cleared. Returns display_name and set; not saved to disk.

Returns: { set: bool, display_name: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
prim_pathYesAbsolute SdfPath of an existing prim, e.g. "/World/Cube".
stage_nameNoName the stage was registered under by create_usd_stage or open_usd_stage; a stage already in the USD cache also matches by the end of its root layer identifier.
display_nameYesLabel that UIs show instead of the prim name, e.g. "Hero Cube"; may be empty.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.2.0
    • changedInput schema / properties / display_name / description
      Previous value: -"New display name"New value: +"Label that UIs show instead of the prim name, e.g. \"Hero Cube\"; may be empty."
    • changedInput schema / properties / prim_path / description
      Previous value: -"Target prim path"New value: +"Absolute SdfPath of an existing prim, e.g. \"/World/Cube\"."
    • changedInput schema / properties / stage_name / description
      Previous value: -"Stage cache key"New value: +"Name the stage was registered under by create_usd_stage or open_usd_stage; a stage already in the USD cache also matches by the end of its root layer identifier."
  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 convey readOnly=false, idempotent=true, destructive=true, so the safety profile is covered. The description nonetheless adds real behavioral value beyond them: the empty-string edge case (written as empty displayName, not cleared) and the critical persistence caveat that changes are not saved to disk.

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 appropriately brief, but the return value is stated twice (once inline and again as 'Returns: { set, display_name }'), which is mild redundancy. Otherwise every sentence earns its place.

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 inline return-shape note is necessary and supplied, and the persistence caveat fills a real gap. Remaining gaps are minor (no error conditions, no explicit need to call save_usd_stage), so it is complete enough to call correctly.

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 adds semantics the schema lacks: the display_name empty-string behavior and the fact that editing displayName does not alter the prim name. This meaningfully extends beyond the field descriptions.

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 (author) and target (displayName metadata on an existing prim of a registered USD stage), and explicitly clarifies the prim name is untouched, which distinguishes it from generic metadata setters. An agent can identify the operation and scope 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 Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It implies context (existing prim, registered stage, current edit target) but offers no explicit when-to-use/when-not guidance and does not contrast itself with the obvious sibling set_usd_prim_metadata. Usage must be inferred.

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