query_instances
Query Roblox instances to get, find children or descendants, search by name or class, and retrieve class information or project structure.
Instructions
Query Roblox instances: get, children, find child/descendant, wait for child, class info, search by name/class. [PRO] file_tree, project_structure, descendants, ancestors, search by property/tag.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Query action to perform. Basic: get, children, find_child, find_descendant, wait_for_child, class_info, search_name, search_class. [PRO]: search_property, search_tag, file_tree, project_structure, descendants, ancestors. | |
| path | No | Instance path to query (e.g., "game.Workspace.Part"). Used by: get, children, find_child, find_descendant, wait_for_child, descendants, ancestors. | |
| childName | No | Name of the child instance to find. Used by: find_child, wait_for_child. | |
| descendantName | No | Name of the descendant instance to find. Used by: find_descendant. | |
| className | No | Roblox class name. Used by: find_child/find_descendant (optional filter), class_info (required), search_class (required). | |
| recursive | No | If true, returns all descendants instead of just immediate children. Used by: children. Default: false. | |
| maxDepth | No | Maximum depth for recursive traversal. Used by: children (default: 10), file_tree (default: 5). | |
| timeout | No | Maximum time to wait in seconds. Used by: wait_for_child. Default: 5. Maximum: 30. | |
| root | No | Root path to search/scan from. Used by: search_name, search_class, search_property, search_tag, file_tree, project_structure. Default: "game". | |
| query | No | Search pattern for name search (supports * and ? wildcards). Used by: search_name. | |
| propertyName | No | [PRO] Property name to search by. Used by: search_property. | |
| propertyValue | No | [PRO] Property value to match. Used by: search_property. | |
| tag | No | [PRO] Tag string to search by (case-sensitive). Used by: search_tag. | |
| includeServices | No | [PRO] Include Roblox services when root is "game". Used by: file_tree. Default: true. | |
| includeSubclasses | No | Include subclasses in class search (e.g., BasePart finds Part, MeshPart). Used by: search_class. Default: true. | |
| caseSensitive | No | Case-sensitive name search. Used by: search_name. Default: false. | |
| maxResults | No | Maximum results to return. Used by: search_name, search_class, search_property, search_tag, descendants. Default: 100. | |
| depth | No | [PRO] Maximum depth for project structure traversal. Used by: project_structure. Default: 3. |