@weaaare/mcp-virtual-screen-reader-auditor 0.0.2 → 0.0.4

package/README.md

@@ -2,7 +2,9 @@
 
 MCP (Model Context Protocol) server for **headless virtual screen reader accessibility audits**. Works on any OS — no native screen reader required. Launches a real browser, injects a virtual screen reader, and navigates the live accessibility tree including dynamic/SPA content.
 
-Covers **WCAG 2.2** criteria using the same audit, findings, and reporting framework as `@weaaare/mcp-voiceover-auditor`.
+Can help cover up to **12 WCAG 2.2 success criteria** using the same audit, findings, and reporting framework as `@weaaare/mcp-voiceover-auditor`.
+
+> **Important:** This tool does **not** replace a manual audit by an accessibility specialist, nor does it substitute real testing with assistive-technology users. It is a fast feedback loop that catches common issues early — a complement, never a replacement.
 
 ## Tools
 
@@ -32,23 +34,25 @@ Covers **WCAG 2.2** criteria using the same audit, findings, and reporting frame
 | `end_audit` | End audit session and return summary data |
 | `generate_report` | Generate reports in Markdown, JSON, or CSV |
 
-## Installation
-
-```bash
-npm install -g @weaaare/mcp-virtual-screen-reader-auditor
-```
+## Getting started
 
-Or use directly with `npx`:
+**Standard config** works in most MCP clients:
 
-```bash
-npx @weaaare/mcp-virtual-screen-reader-auditor
+```json
+{
+  "mcpServers": {
+    "virtual-screen-reader-auditor": {
+      "command": "npx",
+      "args": ["-y", "@weaaare/mcp-virtual-screen-reader-auditor"]
+    }
+  }
+}
 ```
 
-## Configuration
+<details>
+<summary>VS Code</summary>
 
-### VS Code (GitHub Copilot)
-
-Add to `.vscode/mcp.json`:
+Add to your project's `.vscode/mcp.json` (or user-level `settings.json` under `"mcp"`):
 
 ```json
 {
@@ -61,21 +65,133 @@ Add to `.vscode/mcp.json`:
 }
 ```
 
-### Claude Desktop
+Or install via the VS Code CLI:
+
+```bash
+code --add-mcp '{"name":"virtual-screen-reader-auditor","command":"npx","args":["-y","@weaaare/mcp-virtual-screen-reader-auditor"]}'
+```
+
+</details>
+
+<details>
+<summary>Claude Desktop</summary>
+
+Follow the MCP install [guide](https://modelcontextprotocol.io/quickstart/user). Add to your `claude_desktop_config.json` using the standard config above.
+
+</details>
+
+<details>
+<summary>Claude Code</summary>
+
+```bash
+claude mcp add virtual-screen-reader-auditor npx -y @weaaare/mcp-virtual-screen-reader-auditor
+```
+
+</details>
+
+<details>
+<summary>Cursor</summary>
+
+Go to `Cursor Settings` → `MCP` → `Add new MCP Server`. Use `command` type with `npx -y @weaaare/mcp-virtual-screen-reader-auditor`.
+
+Or add to `.cursor/mcp.json` using the standard config above.
+
+</details>
 
-Add to `claude_desktop_config.json`:
+<details>
+<summary>Windsurf</summary>
+
+Follow Windsurf MCP [documentation](https://docs.windsurf.com/windsurf/cascade/mcp). Use the standard config above.
+
+</details>
+
+<details>
+<summary>Cline</summary>
+
+Add to your [`cline_mcp_settings.json`](https://docs.cline.bot/mcp/configuring-mcp-servers#editing-mcp-settings-files):
 
 ```json
 {
   "mcpServers": {
     "virtual-screen-reader-auditor": {
+      "type": "stdio",
       "command": "npx",
-      "args": ["-y", "@weaaare/mcp-virtual-screen-reader-auditor"]
+      "args": ["-y", "@weaaare/mcp-virtual-screen-reader-auditor"],
+      "disabled": false
     }
   }
 }
 ```
 
+</details>
+
+<details>
+<summary>Kiro</summary>
+
+Follow the MCP Servers [documentation](https://kiro.dev/docs/mcp/). Add to `.kiro/settings/mcp.json` using the standard config above.
+
+</details>
+
+<details>
+<summary>Codex</summary>
+
+```bash
+codex mcp add virtual-screen-reader-auditor npx "-y" "@weaaare/mcp-virtual-screen-reader-auditor"
+```
+
+Or edit `~/.codex/config.toml`:
+
+```toml
+[mcp_servers.virtual-screen-reader-auditor]
+command = "npx"
+args = ["-y", "@weaaare/mcp-virtual-screen-reader-auditor"]
+```
+
+</details>
+
+<details>
+<summary>Goose</summary>
+
+Go to `Advanced settings` → `Extensions` → `Add custom extension`. Use type `STDIO` and set the command to `npx -y @weaaare/mcp-virtual-screen-reader-auditor`.
+
+</details>
+
+<details>
+<summary>Warp</summary>
+
+Go to `Settings` → `AI` → `Manage MCP Servers` → `+ Add`. Use the standard config above.
+
+</details>
+
+<details>
+<summary>Gemini CLI</summary>
+
+Follow the MCP install [guide](https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md#configure-the-mcp-server-in-settingsjson). Use the standard config above.
+
+</details>
+
+## WCAG criteria covered
+
+| SC | Name | Tools |
+| --- | --- | --- |
+| 1.1.1 | Non-text Content | `virtual_item_text`, `virtual_last_spoken_phrase`, `log_finding` |
+| 1.3.1 | Info and Relationships | `virtual_perform`, `virtual_item_text`, `log_finding` |
+| 2.1.1 | Keyboard | `virtual_press`, `virtual_act`, `log_finding` |
+| 2.1.2 | No Keyboard Trap | `virtual_press`, `virtual_next`, `log_finding` |
+| 2.4.1 | Bypass Blocks | `virtual_perform`, `virtual_next`, `log_finding` |
+| 2.4.2 | Page Titled | `virtual_item_text`, `virtual_last_spoken_phrase`, `log_finding` |
+| 2.4.3 | Focus Order | `virtual_next`, `virtual_previous`, `log_finding` |
+| 2.4.4 | Link Purpose (In Context) | `virtual_perform`, `virtual_item_text`, `log_finding` |
+| 2.4.6 | Headings and Labels | `virtual_perform`, `virtual_item_text`, `log_finding` |
+| 3.3.1 | Error Identification | `virtual_last_spoken_phrase`, `virtual_item_text`, `log_finding` |
+| 3.3.2 | Labels or Instructions | `virtual_item_text`, `virtual_perform`, `log_finding` |
+| 4.1.2 | Name, Role, Value | `virtual_last_spoken_phrase`, `virtual_item_text`, `log_finding` |
+
+## Acknowledgements
+
+- **[W3C](https://www.w3.org/WAI/)** — for the [WCAG 2.2](https://www.w3.org/TR/WCAG22/) guidelines, [WAI-ARIA](https://www.w3.org/TR/wai-aria/) specification, and the [ARIA Authoring Practices Guide](https://www.w3.org/WAI/ARIA/apg/). W3C content is used under the [W3C Software and Document License](https://www.w3.org/copyright/software-license/).
+- **[a11ysupport.io](https://a11ysupport.io/)** — community-driven assistive-technology support data by Michael Fairchild, available under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
+
 ## License
 
 MIT - [weAAAre](https://weAAAre.com)

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+#!/usr/bin/env node
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 import { createServer } from './server.js';
 const main = async () => {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IACrC,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IACrC,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weaaare/mcp-virtual-screen-reader-auditor",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "MCP server for virtual screen reader accessibility auditing — headless browser-based screen reader simulation that works on any OS",
   "license": "MIT",
   "type": "module",
@@ -16,7 +16,7 @@
     "@guidepup/virtual-screen-reader": "0.32.1",
     "@modelcontextprotocol/sdk": "1.27.1",
     "playwright-core": "1.58.2",
-    "@weaaare/mcp-auditor-core": "^0.0.2"
+    "@weaaare/mcp-auditor-core": "^0.0.3"
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.6",
@@ -36,12 +36,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/weAAAre/accessibility-ai.git",
+    "url": "git+https://github.com/weAAAre/a11y-agents-kit.git",
     "directory": "packages/mcp-virtual-screen-reader-auditor"
   },
-  "homepage": "https://github.com/weAAAre/accessibility-ai/tree/main/packages/mcp-virtual-screen-reader-auditor#readme",
+  "homepage": "https://github.com/weAAAre/a11y-agents-kit/tree/main/packages/mcp-virtual-screen-reader-auditor#readme",
   "bugs": {
-    "url": "https://github.com/weAAAre/accessibility-ai/issues"
+    "url": "https://github.com/weAAAre/a11y-agents-kit/issues"
   },
   "author": "weAAAre <hola@weAAAre.com> (https://weAAAre.com)",
   "engines": {