Get the descendants tree of a Roblox instance
get-descendants-treeExplore the hierarchy of descendants under a Roblox instance up to a specified depth. Filter by class or limit children per node to manage output size.
Instructions
Get a depth-limited hierarchy of descendants under a Roblox instance. Use for broad structure exploration; use search-instances for selector-based filtering.
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": {
"root": "<root>"
},
"name": "get-descendants-tree"
}
}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: 3). 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: 50). Prevents overwhelming output for large containers. |