Walk a depth-limited instance hierarchy
get-instance-treeExplore Roblox instance hierarchies by returning a nested name/class/children tree from a dotted path (default game), capped by depth and child limits with truncation counts.
Instructions
Return a nested { name, class, children } tree under an instance resolved from a dotted path (default 'game'), capped by maxDepth and maxChildren so large containers don't overwhelm the output. Each node lists how many children were truncated. Use this for broad structure exploration; use get-instance-properties to read one instance's values. The path is pcall-resolved, so a bad path returns { error } rather than failing. Signature: { path: string?, maxDepth: number?, maxChildren: number? }. Phase: observe; cost=high; idempotency=read-only. Requires: active-client, resolved-target. Produces: bounded-candidates, structured-observation. Safety: read-only. On failure: inspect tool-schema for exact fields, defaults, constraints, and an invocation example.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Dotted path to the root instance (e.g. 'game.Workspace'). | game |
| maxDepth | No | Maximum traversal depth (1-20, default 3). | |
| maxChildren | No | Maximum children shown per node (1-500, default 50). |