Repository navigation
NVDA MCP 1.0.0
First release, on the NV Access Add-on Store and PyPI.
Added
- An NVDA add-on with a loopback bridge protected by a per-start token, and an MCP server published on PyPI
asnvda-mcp. It runs withuvx nvda-mcp,pipx install nvda-mcporpython -m nvda_mcp. - NVDA MCP settings: Set up this MCP client and Copy setup command copy the command (Claude Code, Codex CLI)
or the JSON settings (Claude Desktop, Cursor and others) that start the server version matching the add-on. - Reading:
nvda_get_status,nvda_get_focus(withdocumentMode, browse or focus),nvda_get_navigator_object,
nvda_get_object_tree(at mostmax_childrenchildren of each object),nvda_get_text(withcontains
to search without moving the cursor) andnvda_get_speech_history. - Speech:
nvda_speak, andnvda_wait_for_speechto wait until NVDA says something, such as a chat reply. - Keys and typing:
nvda_press_keyspresses keys as the user would, so NVDA runs its command for a key first,
and takesholdto keep alt, control, shift or windows down across several keys.nvda_type_texttypes
a line of text in any language, emoji included, without using the clipboard. - Windows:
nvda_list_windows, optionally including other virtual desktops, andnvda_activate_window. - Controls:
nvda_find_objects,nvda_focus_objectandnvda_activate_object;nvda_audit_focus_order. - Web pages and documents:
nvda_set_document_mode,nvda_find_in_page, andnvda_list_elementsand
nvda_move_to_element, like the Elements List. - Expected results: every action tool takes
until_speech, keeps listening until NVDA says that text,
and reports whether it was heard. - Tools for developers of NVDA add-ons and accessible applications:
nvda_preview_speechsays what NVDA would announce when a control gets focus, without moving focus.
Withtarget: "window"it checks the focused control and the controls of the foreground window,
and flags unlabeled and silent ones.nvda_trace_eventsrecords the events NVDA handles and what NVDA said for each, including speech that comes
just before or after an event, such as a browser's live region. It stops by itself after 10 minutes.nvda_get_logreads NVDA's log; IO entries, which record keys typed, are left out unless asked for.nvda_get_output_historyshows beeps, sounds, braille output and speech being cut off.nvda_get_dev_infoshows NVDA's developer info for a control, like NVDA+F1.nvda_list_scriptslists the NVDA commands available where focus is, or says which command a key runs.nvda_run_scriptruns an NVDA command by name;nvda_reload_pluginsreloads add-ons and app modules.nvda_get_settingsreads NVDA's settings as they apply now. Values whose names suggest secrets are hidden.nvda_run_scenarioruns key presses and typing, records what NVDA said after each step, and saves it
as a baseline file or compares it with one.
- Safety:
- Pressing keys is off by default. NVDA asks before the first key press after it starts, in a dialog whose
title names the MCP client asking. - A setting to let MCP clients control only some applications.
- A log of every action clients take (
%APPDATA%\nvda\nvdaMcp\actions.log), with a setting to turn it off,
an NVDA command to open it and thenvda_get_action_logtool. - When the add-on and the server don't match, the error says which one is older and how to update it.
- Pressing keys is off by default. NVDA asks before the first key press after it starts, in a dialog whose
- A Donate button in the NVDA MCP settings, and donation links on GitHub, PyPI and in the README.
- Help pages and translation in English and Indonesian.
- docs/using.md, CONTRIBUTING.md and
THIRD_PARTY_NOTICES.md.