query_instances
Query Roblox instances in the game hierarchy. Retrieve objects by path, class, name, property, or tag, and explore their children, descendants, and structure.
Instructions
Query instances in the Roblox place. Prefer a typed action over execute_luau. Actions: get, children, descendants, ancestors, find_child, find_descendant, wait_for_child, search_class, search_name, search_property, search_tag, class_info, file_tree (nested outline), project_structure (service/script counts). Paths: 'game.Workspace.Model.Part' or 'Workspace/Model/Part'. Prefer rbId (from a prior summary) over path when both are set — names like Part are not unique. Aliases: childName/descendantName/query→name, root→path, propertyName→property, id→rbId.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Alias for rbId | |
| tag | No | Tag for search_tag | |
| name | No | Child/descendant name or name substring for searches | |
| path | No | Instance path. Defaults to game. Alias: root. An RBId GUID is also accepted. | |
| rbId | No | RoBridge instance id from a prior summary. Preferred over path when both are set. Alias: id | |
| root | No | Alias for path | |
| depth | No | Alias for maxDepth | |
| query | No | Alias for name (search_name) | |
| value | No | Optional property value to match (search_property) | |
| action | Yes | ||
| timeout | No | Seconds to wait (wait_for_child, default 5, max 30) | |
| maxDepth | No | Max depth for file_tree (default 5) / project_structure (default 3) | |
| property | No | Property name for search_property | |
| childName | No | Alias for name (find_child / wait_for_child) | |
| className | No | ClassName for search_class / class_info | |
| maxResults | No | Max results for searches/descendants (default 100) | |
| includeProps | No | Include common properties in results | |
| propertyName | No | Alias for property | |
| propertyValue | No | Alias for value | |
| descendantName | No | Alias for name (find_descendant) |