Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

set_usd_prim_instanceable

DestructiveIdempotent

Set or clear a USD prim's instanceable metadata to enable native instancing, operating on the current edit target of a registered stage.

Instructions

Set or clear the instanceable metadata (USD native instancing) of an existing prim on a registered USD stage, at the current edit target. Returns instanceable (the requested value, or the current one when the write fails) and set. Not saved to disk.

Returns: { instanceable: bool, prim_path: 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.
instanceableNotrue to mark instanceable, false to clear; omitted means true.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.2.0
    • changedInput schema / properties / instanceable / description
      Previous value: -"true to mark instanceable, false to clear"New value: +"true to mark instanceable, false to clear; 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

A3.9/5.0
Behavior4/5

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

Annotations already declare it non-readonly, destructive and idempotent, so the safety profile is covered. The description adds real context beyond that: the write happens at the current edit target, changes are NOT saved to disk, and the returned instanceable reflects the requested value or the current one when the write fails. That is genuinely useful behavioral disclosure.

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 purpose, followed by behavioral caveats then a return summary. Slightly redundant: the prose return note and the explicit 'Returns:' block overlap, and the block lists only instanceable/prim_path while the prose also mentions 'set' — minor inconsistency, but no wasted sentences overall.

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 description carries the return-shape burden and does so (instanceable, prim_path, plus the failure semantics of the returned value). It also discloses the non-persistence caveat. Complete enough for an agent to call it correctly, though alternative-tool guidance is absent.

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 prim_path, stage_name and instanceable are already documented. The description adds only marginal meaning (the metadata target and the current-edit-target context) and does not expand on parameter syntax. Baseline 3 is appropriate when the schema does the heavy lifting.

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 (set/clear) applied to a specific resource (instanceable metadata / USB native instancing) of an existing prim on a registered USD stage. It is distinguishable from siblings like set_usd_prim_metadata or set_usd_prim_active without opening a 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?

The description gives context (registered USD stage, current edit target) but never states when to choose this tool over related siblings such as set_usd_prim_metadata or set_usd_prim_active, nor any prerequisites or exclusions. Usage is only implied by the domain.

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