Skip to main content
Glama

get_prim_properties

Read-only

Read a single USD prim's type, world transform, bounds, physics flags, API schemas, variant sets, attributes, and relationships to inspect its Omniverse Kit scene state.

Instructions

Get one prim as a prim block: its type, world position and rotation, world bounding box, physics flags, its applied API schemas, its variant sets, every attribute's value, and each relationship with its targets.

Use it to read one prim; get_prim_bounds when only its size and place matter, get_scene_tree to find paths, and with include_properties for many prims at once, written to a file. The rotation, rot, is a quaternion w, x, y, z with any scale taken out; a prim scaled to 0 has none. api_schemas lists the applied API schemas the Kit app knows, a type's built-in ones included, [] for none: PhysicsCollisionAPI for a collider, MaterialBindingAPI for a bound material. variant_sets lists each variant set with its selection (none when there is none), its options, and the layer holding the selection: session (Kit's session layer, which set_variant_selection writes by default), root, or a file's name; [] for no set, such as state: open [closed, open] (session). A relationship gives its targets, such as material:binding = /World/Looks/Red; one with none is left out, as an unset attribute is.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "prim_path": "<prim_path>"
    },
    "name": "get_prim_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
prim_pathYesFull USD path of the prim, e.g. "/World/Robot"

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.2

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered and the description's job is to add context. It does add real behavioral detail: quaternions have scale factored out, zero-scaled prims have no rotation, unset attributes and empty relationships are omitted rather than null, and variant set selection provenance (session/root/file) is reported. A 3 reflects that the annotations plus the added edge-case semantics combine well, though most of the added text is return-shape material rather than operational behavior such as cost or failure modes.

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

Conciseness3/5

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

The purpose and routing sentence is correctly front-loaded, which is good. But the remaining two dense paragraphs are almost entirely return-value formatting detail, and the tool already ships an output schema, so that material is largely redundant and makes the definition longer than it needs to be.

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 one-parameter, read-only inspection tool with full schema coverage and an output schema, nothing needed to call it correctly is missing. Selection rules, edge cases, and sibling routing are all present, and the return format is definitionally covered by the output schema even if the description over-explains it.

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?

There is a single required parameter, prim_path, with 100% schema description coverage and an example path already in the schema. The description adds no syntax, wildcarding, or path-resolution guidance beyond what the schema states. Baseline 3 applies when the schema does all the parameter work.

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?

Opens with a specific verb and resource ("Get one prim as a prim block") and then enumerates exactly what the block contains: type, transform, bounds, physics flags, API schemas, variant sets, attributes, and relationships. It explicitly names the siblings it is not (get_prim_bounds, get_scene_tree, include_properties), so an agent can separate it from near-neighbors 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 Guidelines5/5

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

Gives an explicit routing rule: use this to read one prim, use get_prim_bounds when only size and place matter, use get_scene_tree to find paths, and use include_properties for many prims written to a file. Both the when-to-use and the when-to-use-something-else conditions are stated, including the single-vs-batch boundary.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.