Get the descendants tree of a Roblox instance
get-descendants-treeExplore the structure under a Roblox instance. Defaults to a compact summary (child/class counts); set summaryOnly=false for the full tree. Use search-instances for selector-based filtering.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| root | Yes | The instance path to get the tree from (e.g., 'game.Workspace', 'game.Workspace.CurrentRooms') | |
| maxDepth | No | Maximum depth to traverse (default: 2, max: 5). Higher values return more detail but larger output. | |
| classFilter | No | Optional class name filter — only show instances that IsA this class (e.g., 'BasePart', 'Model'). Leave empty to show all. | |
| maxChildren | No | Maximum number of children to show per node (default: 20, max: 30). Prevents overwhelming output for large containers. | |
| summaryOnly | No | When true (default), return compact child counts and class counts instead of the full tree. Set false only when you need the actual hierarchy. | |
| maxOutputChars | No | Maximum characters to return to the model (default: 6000, max: 32000). Raise only when a single result genuinely needs more; large outputs degrade model performance. |