Skip to main content
Glama

get_scene_tree

Read-only

Lists a USD stage's prims under a root with paths, types, and world positions, helping you find prim paths before inspecting or editing them. Use filters or include properties to write details to a file.

Instructions

List the stage's prims under root as prim blocks: each one's path, type and world position, to max_depth.

Use it to find prim paths before acting on them: it is the lightest look at a scene. A prim at max_depth that has children says how many, as children = N (truncated), and nothing below it is listed. The prims inside an instanceable prim are not listed (get_mesh_stats looks inside). With include_properties, filter_types or property_filter, Kit writes the blocks to mcp_output/scene_dump.txt instead, replacing the last, each with the prim's rotation, world box and physics flags, and its applied API schemas, variant sets, attribute values and relationship targets with include_properties or property_filter; the answer gives the file's path, how many prims it holds and how deep it went: grep it, or read it in parts. Kit writes that file itself, so with Kit on another machine it lands there. get_prim_properties reads one prim inline.

The positions and rotations follow the simulation, where physics has each rigid body while it plays or after a pause, so one call with property_filter=["physics:"] gives where every body under root came to rest, whatever the filter keeps of the rest.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_scene_tree"
  }
}

Input Schema

NameRequiredDescriptionDefault
rootNoPrim path to start from/
max_depthNoHow many levels below root: 5 when left out, or 15 with properties or a filter; in the list, a prim on the last level says how many children it has
filter_typesNoOnly prims of these types, e.g. ["Mesh", "Xform"], written to the file; the others' children are still walked
property_filterNoOnly properties whose names hold one of these, e.g. ["joint"], written to the file; it takes the properties with it. ["variant_sets"] lists every prim's variant sets: a scene's switches
include_propertiesNoEach prim's rotation, world box, applied API schemas, variant sets, attribute values and relationship targets, written by Kit to mcp_output/scene_dump.txt

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.4.1
    • addedInput schema / properties / filter_types
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Only prims of these types, e.g. [\"Mesh\", \"Xform\"], written to the file; the others' children are still walked",
      +  "title": "Filter Types"
      +}
    • addedInput schema / properties / include_properties
      Added value: +{
      +  "default": false,
      +  "description": "Each prim's rotation, world box, applied API schemas, variant sets, attribute values and relationship targets, written by Kit to mcp_output/scene_dump.txt",
      +  "title": "Include Properties",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / max_depth / anyOf
      Added value: +[
      +  {
      +    "minimum": 0,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / max_depth / default
      Previous value: -5New value: +null
    • changedInput schema / properties / max_depth / description
      Previous value: -"How many levels below root to list; the next shows only prims with children"New value: +"How many levels below root: 5 when left out, or 15 with properties or a filter; in the list, a prim on the last level says how many children it has"
    • removedInput schema / properties / max_depth / maximum
      Removed value: -15
    • removedInput schema / properties / max_depth / minimum
      Removed value: -0
    • removedInput schema / properties / max_depth / type
      Removed value: -"integer"
    • addedInput schema / properties / property_filter
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Only properties whose names hold one of these, e.g. [\"joint\"], written to the file; it takes the properties with it. [\"variant_sets\"] lists every prim's variant sets: a scene's switches",
      +  "title": "Property Filter"
      +}
  2. Changed1 schema field changedv0.2.3
    • changedInput schema / properties / max_depth / description
      Previous value: -"How many levels below root; 0 for root alone"New value: +"How many levels below root to list; the next shows only prims with children"
  3. First observedv0.2.2

TDQS

A4.5/5.0
Behavior5/5

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

Beyond readOnlyHint/openWorldHint it discloses truncation semantics ('children = N (truncated)'), that instanceable prim contents are omitted, the effective default depths, that three of the parameters silently switch output to mcp_output/scene_dump.txt and overwrite the previous file, and that the file lands on Kit's machine rather than the caller's. It also explains that positions/rotations track simulation state, which is non-obvious behavioral context an agent could not infer from annotations or schema.

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 core statement is front-loaded and no sentence is pure filler, but the middle section is a run-on with tangled clauses ('replacing the last, each with the prim's rotation, world box and physics flags...'), and defaults are repeated from the schema. It is dense rather than tight — appropriate information, poor sequencing.

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 five-parameter read tool with an output schema, it covers everything that matters: defaults, truncation, instance behavior, the file-output branch including its path, size and remote-host caveat, and the simulation-frame caveat on returned transforms. Even though an output schema exists, the alternate file return path is explained, which the schema alone would not convey.

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 cross-parameter meaning the schema does not convey: any of include_properties/filter_types/property_filter redirects output to a file, filter_types still walks the children of excluded prims, and property_filter=["variant_sets"] is a special switch-listing mode. The only weakness is that it restates default depths already documented in the schema.

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?

The first sentence gives a specific verb and resource — 'List the stage's prims under root' — plus exactly what each entry carries (path, type, world position) and the depth bound. It also differentiates against siblings by name: get_mesh_stats 'looks inside' instances and get_prim_properties 'reads one prim inline', so an agent can tell them apart without opening any 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?

It states the intended use case plainly ('find prim paths before acting on them') and characterizes the tool as 'the lightest look at a scene', then routes property reads to get_prim_properties and instance interiors to get_mesh_stats. That is strong alternative routing, but it never frames an explicit when-not-to-use condition (e.g. large scenes where the file dump is always preferable), so it stops short of a full 5.

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