list_descendants

Lists children or the full descendant tree of an instance.

What it does

list_descendants walks the DataModel under a given path and returns each descendant's name, class, and full path. This is how Revix understands your game structure — what is inside Workspace, what scripts live in ServerScriptService, what UI is parented under a ScreenGui.

You can cap traversal depth with the optional depth parameter (1-20). With no depth, it returns the full tree under the path. Large trees are truncated server-side, and the response notes when truncation has occurred so Revix knows to scope deeper into specific subtrees.

It is also how Revix finds scripts or instances by name pattern: it lists the relevant subtree and filters by className or name in subsequent reasoning, rather than guessing paths.

Parameters

NameTypeRequiredDescription
`path`stringyesDataModel path (e.g. `Workspace`, `StarterGui`, `ServerScriptService`).
`depth`numbernoHow many levels deep to traverse (1-20). Default: unlimited.

When Revix uses it

  • Surveying Workspace before adding new parts
  • Finding the right place to insert a new script
  • Discovering existing UI elements under a ScreenGui
  • Locating a script by name when the exact path is unknown

Example

text
ServerScriptService (3 descendants):
  ServerScriptService/GameManager  [Script]
  ServerScriptService/PlayerStats  [Script]
  ServerScriptService/Modules      [Folder]
  ServerScriptService/Modules/Inventory  [ModuleScript]

Troubleshooting

If output is truncated, narrow the path or set a smaller depth. See building instances for path conventions.