All tools

ui_read_tree

Screen, windows & UI · macOS · Windows

Effect: read (strongest supported action). Status: gated.

Gated means the tool requires an installed app, a connected account, permission, or runtime availability. Check those requirements on the listed platform before using it.

macOS

Purpose

Returns a COMPACT accessibility tree of a running native app's labeled + interactive elements (buttons, links, text fields, checkboxes, menus…) — the native equivalent of web_read's a11y mode. Use it to DISCOVER what to act on in an unfamiliar app when you don't already know an element's role/label (ui_find_element needs one up front). Each interactive node carries a `ref` you can pass straight to ui_click. Pass app_bundle_id of a running app (e.g. com.apple.finder — see list_windows); the tree is pruned to signal-bearing nodes and bounded by max_depth (default 12) and a node budget, so very large windows return partial. The app's macOS menu bar is skipped by default (it's hundreds of menu-item nodes) — pass include_menu_bar=true if you specifically need to act on menu-bar items.

Required inputs

No required inputs are declared in this platform's schema. Optional selectors and runtime requirements may still apply.

Permissions and confirmation

No explicit confirmation parameter is exposed in this snapshot. This does not grant permission to act: obtain user authorization before any real action.

Full input schema — macOS
{
  "properties": {
    "app_bundle_id": {
      "description": "Bundle id of a RUNNING app (e.g. com.apple.finder)",
      "type": "string"
    },
    "include_menu_bar": {
      "description": "Include the app's macOS menu bar (hundreds of menu-item nodes). Default false.",
      "type": "boolean"
    },
    "max_depth": {
      "description": "Max tree depth to descend (default 12, max 20)",
      "type": "integer"
    },
    "window_id": {
      "description": "Alternative to app_bundle_id: a window id from list_windows (targets that window's app)",
      "type": "string"
    }
  },
  "required": [],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{}

Windows

Purpose

Returns a COMPACT UI Automation tree of a running Windows app's labeled + interactive elements (buttons, links, edits, checkboxes, menus…) — the native equivalent of web_read's a11y mode. Use it to DISCOVER what to act on in an unfamiliar app when you don't already know an element's role/label (ui_find_element needs one up front). Each interactive node carries a `ref` you can pass straight to ui_click. Pass `app` (a running app's process name, e.g. notepad). The tree is pruned to signal-bearing nodes and bounded by max_depth (default 12) and a node budget, so very large windows return partial.

Required inputs

No required inputs are declared in this platform's schema. Optional selectors and runtime requirements may still apply.

Permissions and confirmation

No explicit confirmation parameter is exposed in this snapshot. This does not grant permission to act: obtain user authorization before any real action.

Full input schema — Windows
{
  "properties": {
    "app": {
      "description": "Process name of a RUNNING app (e.g. notepad).",
      "type": "string"
    },
    "max_depth": {
      "description": "Max tree depth to descend (default 12, max 20).",
      "type": "integer"
    }
  },
  "required": [],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{}