Skip to content

NVDA MCP 1.1.0

Choose a tag to compare

@github-actions github-actions released this 04 Nov 21:25
· 9 commits to main since this release
5b13019

Added

  • nvda_find_objects takes within, an id from the previous search, to search only inside that control.
    On large web pages such as WhatsApp Web, a search of the whole window can stop after 3 seconds
    before it reaches the part that matters.

  • nvda_inspect_object, for add-on developers: a control's IAccessible2 attributes (HTML tag, id, class,
    ARIA role, where its name comes from) or UIA properties, the containers above it, its first children,
    and for tables and lists how many rows exist now compared with how many the application reports.
    It ranks the conditions an add-on could match the control on, from most to least stable, warns about class
    names that look generated by a build tool, and gives example chooseNVDAObjectOverlayClasses code.

  • nvda_find_objects and nvda_get_object_tree take window, a handle from nvda_list_windows,
    to read a window in the background or on another virtual desktop without bringing it to the front.
    Chromium browsers and Electron apps stop exposing their page some time after their window is hidden;
    the result then says so, and that the window needs to come to the front first.

  • nvda_get_object_tree takes id to start from a control found with nvda_find_objects.

  • nvda_trace_events takes background_window to ask NVDA for events from a window in the background,
    as an add-on can with eventHandler.requestEvents. They are recorded with the control's value and
    the text of live regions and alerts, but NVDA does not act on them.

  • nvda_set_value (experimental) gives an edit field new text through UI Automation or IAccessible,
    without the keyboard or focus, and reports whether the field took it.

  • Recording what an action changed, for add-on developers. Action tools such as nvda_press_keys,
    nvda_activate_object and nvda_set_value take record (or record_within, an id): the result then also
    says how the accessibility tree around the action changed (controls added, removed, renamed or moved,
    values and states, lists that scrolled) and which events NVDA handled. nvda_trace_events takes tree
    (or tree_within) to do the same for something the user does, from start to stop. The comparison never
    reports a control as removed when it was simply not read, and reads the part around the focus first.

  • nvda_inspect_html and nvda_find_html, for developers of add-ons for web apps: the HTML element behind a
    control in Chrome, Brave or Edge, read through the browser's remote debugging, with the data attributes,
    HTML, styles and event listeners that NVDA cannot see. The control is matched with its element exactly,
    through the DOM node id Chromium gives it. Off until you check the new setting
    Let MCP clients read the HTML of web pages through the browser's remote debugging; NVDA says when
    it connects, and the browser asks before every new connection. Only the page you work with is read:
    no scripts are run and your other tabs are never listed.

  • nvda_lookup_api, for add-on developers: checks a name in the Python code of the NVDA that is running,
    before it goes into an add-on. It says whether the name exists, what it is, its signature, docstring and
    members, where it is defined with a link to NVDA's source for that release, and whether it looks deprecated,
    and suggests close names when it does not exist. With search it finds names in NVDA's and add-ons' modules.
    It only reads, and does not run the code it looks at.

  • nvda_capture_control, for developers: a picture of a control on the screen next to what NVDA says for it,
    to find icons and visible text the accessible name leaves out. Off until you check the new setting
    Let MCP clients take pictures of controls on the screen. It captures the way NVDA's own text recognition
    does, so it works with Screen Curtain on, and every picture is written to the action log.

  • Ready-made MCP prompts for common developer tasks: audit_accessibility, build_addon, why_silent and
    check_labels. Clients that support prompts offer them as commands.

Changed

  • Ids from nvda_find_objects stay valid through later searches, until the control disappears,
    so a container's id still works after searching inside it.
  • When nvda_find_objects searches several parts of a window, such as a web page and then the browser
    around it, they share one 3-second time limit instead of 3 seconds each.
  • nvda_trace_events no longer records which character a typed-character event carried, so passwords stay
    out of traces (NVDA only says "star" for them). What NVDA speaks as you type in other fields is still recorded.
  • The bridge protocol version is now 7. Update the add-on and the server together.

Fixed

  • Your answer to "allow ... to press keys?" now lasts until NVDA restarts, as the question says,
    instead of being forgotten when plugins are reloaded.
  • An unanswered "allow ... to press keys?" question closes by itself, with an announcement, before the
    MCP client stops waiting. Before, answering Yes much later still ran the old action, and every other
    action waited behind the open question. An action that cannot start in time fails with controlBusy.
  • Escape answers No in that question; before, it did nothing.
  • Using the id of a web page's control that has disappeared now fails with staleObject. Before, NVDA still
    answered for it as an unknown object, so the action failed later with a less helpful error.
  • nvda_get_object_tree no longer drops a control and everything in it when it is the last one shown
    and its own children were cut short; on WhatsApp Web most of the page went missing this way.
  • nvda_activate_window now brings NVDA along when Windows switches virtual desktops to reach the window.
    Windows sends no event then, so NVDA kept reading the old window and the result showed the old focus.
    NVDA then says the window title once, as after Alt+Tab; at first it said it twice in browsers.
  • nvda_activate_window says the window title once when the page in a Chromium browser or Electron app
    is in focus mode, as in WhatsApp Web. These applications send no focus event for their window, so NVDA said
    the title on entering the window and again on switching to focus mode, even on the same virtual desktop.
    The add-on now tells NVDA about the window as soon as it comes to the front. Pages in browse mode
    and other applications are left to NVDA, which says the title once there.