Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

set_usd_prim_active

DestructiveIdempotent

Toggle a prim's active state on a registered USD stage to include or exclude it from composition without removal. Inactive prims stay addressable.

Instructions

Activate or deactivate an existing prim on a registered USD stage (active metadata on the current edit target). An inactive prim and its subtree leave composition but stay addressable, the reversible alternative to remove_usd_prim. Returns active and set; not saved to disk.

Returns: { active: bool, prim_path: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
activeNotrue to activate, false to deactivate; omitted means true.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.2.0
    • changedInput schema / properties / active / description
      Previous value: -"true to activate, false to deactivate"New value: +"true to activate, false to deactivate; omitted means true."
    • 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.3/5.0
Behavior4/5

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

Adds substantial behavior beyond the annotations: an inactive prim and its subtree leave composition but stay addressable, scope is the current edit target, and the change is not saved to disk. The only tension is that it markets itself as 'reversible' while the annotation declares destructiveHint=true, which a careful agent may need to reconcile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the operation and scope, then adds the reversibility contrast and the return shape in a compact, waste-free block. Every clause carries information.

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 mutation tool, the description covers safe-use context, reversibility, persistence behavior, and the return payload even though no output schema exists. Nothing an agent needs in order to call it 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 coverage is 100% and all three parameters carry descriptions, so the schema already does the heavy lifting. The description adds a useful detail about the current edit target, but no syntax or format information beyond what the schema provides, landing at the baseline.

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 precise verb pair (activate/deactivate) and an exact resource (an existing prim on a registered USD stage), and explicitly contrasts itself with remove_usd_prim. An agent can distinguish it from the sibling set without opening either 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?

Names the alternative (remove_usd_prim) and frames this tool as the reversible substitute, which is strong positive routing guidance. It stops short of stating explicit prerequisites or a when-not-to-use condition, so it is clear context rather than 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