Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

remove_usd_prim

Destructive

Delete a prim and its subtree from the current edit target layer of a registered USD stage, returning whether it was removed; changes are not saved to disk.

Instructions

Remove a prim and its subtree from the current edit target layer of a registered USD stage, returning removed. Opinions in other layers or references can keep it composed; set_usd_prim_active with active=false is the reversible way to hide a prim. Not saved to disk.

Returns: { removed: bool, prim_path: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
prim_pathYesAbsolute SdfPath of the prim to remove, e.g. "/World/Cube"; its descendants go with it.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.0
    • changedInput schema / properties / prim_path / description
      Previous value: -"SdfPath to remove"New value: +"Absolute SdfPath of the prim to remove, e.g. \"/World/Cube\"; its descendants go with it."
    • 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.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and not-readOnly, so safety is partly covered. The description adds real value beyond that: the removal is confined to the current edit target layer, other layers can keep the prim composed, and it is not persisted to disk. It stops short of noting auth/permission requirements or idempotency behavior of repeated calls.

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-loads the action and scope, then layers the routing hint and persistence note efficiently. Minor awkwardness in 'returning removed,' but overall tight with little waste.

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 destructive removal tool with no output schema, the description supplies the return shape, the layer-scoped behavior, the persistence caveat, and the non-destructive alternative. An agent has everything needed to call it correctly.

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 both prim_path and stage_name are fully documented in the schema. The description's 'prim and its subtree' phrasing corroborates the cascade behavior of prim_path, but adds no syntax or format detail beyond the schema. 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 (Remove), resource (a prim and its subtree), and scope (from the current edit target layer of a registered USD stage). It is clearly distinguishable from siblings like set_usd_prim_active, remove_usd_prim_schema, and remove_usd_attribute.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

Names the alternative explicitly: 'set_usd_prim_active with active=false is the reversible way to hide a prim,' giving the condition that selects the non-destructive sibling. It also warns that opinions in other layers or references can keep the prim composed, clarifying when removal won't achieve the user's intent.

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