get_ui_elements
Lists running scene Controls with rect, type, and text so you can find names and paths before simulating clicks. Filter by class, scope to a root, and skip hidden or clipped elements.
Instructions
List the running scene Controls with rect, type and text. Call before simulate_input click_element to find names and paths. Needs a runtime session. visibleOnly (default true) drops hidden Controls and ones clipped out of view. filter narrows by class; root limits the list to one Control and its descendants. Returns: projectPath, elements[] with path/type/rect/visible/onScreen (visibleRect if clipped), optional text/disabled/tooltip. Errors on a non-Control filter or an unknown root.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_ui_elements"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| root | No | List only this Control and its descendants. Same lookup as simulate_input click_element: absolute path, relative path or node name (BFS matched). Visibility and clipping by ancestors above it still apply. An unknown name, or a node that is not a Control, is an error. | |
| filter | No | Filter by native Control class name (e.g. "Button", "Label", "LineEdit"); subclasses match. A class Control inherits from (CanvasItem, Node) lists every Control. Any other name, including a script class_name, is an error. | |
| visibleOnly | No | Only return Controls that are visible in the tree and have area on screen, not clipped away by a ScrollContainer, a clip_contents ancestor or the viewport (default: true). Set false to include the rest. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tip | Yes | ||
| elements | Yes | ||
| warnings | No | ||
| projectPath | Yes |