mcp-accessibility-scanner 3.0.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +232 -7
- package/lib/browserContextFactory.js +645 -32
- package/lib/browserContextFactory.js.map +1 -1
- package/lib/browserServerBackend.js +8 -2
- package/lib/browserServerBackend.js.map +1 -1
- package/lib/context.js +179 -62
- package/lib/context.js.map +1 -1
- package/lib/extension/extensionContextFactory.js +3 -0
- package/lib/extension/extensionContextFactory.js.map +1 -1
- package/lib/mcp/proxyBackend.js +1 -0
- package/lib/mcp/proxyBackend.js.map +1 -1
- package/lib/networkPolicy.js +73 -0
- package/lib/networkPolicy.js.map +1 -0
- package/lib/program.js +21 -3
- package/lib/program.js.map +1 -1
- package/lib/response.js +8 -3
- package/lib/response.js.map +1 -1
- package/lib/tab.js +117 -16
- package/lib/tab.js.map +1 -1
- package/lib/tools/auditKeyboard.js +203 -0
- package/lib/tools/auditKeyboard.js.map +1 -1
- package/lib/tools/auditScreenReader.js +826 -0
- package/lib/tools/auditScreenReader.js.map +1 -0
- package/lib/tools/auditSite.js +267 -86
- package/lib/tools/auditSite.js.map +1 -1
- package/lib/tools/axe.js +479 -21
- package/lib/tools/axe.js.map +1 -1
- package/lib/tools/dialogs.js +18 -4
- package/lib/tools/dialogs.js.map +1 -1
- package/lib/tools/evaluate.js +34 -5
- package/lib/tools/evaluate.js.map +1 -1
- package/lib/tools/keyboard.js +1 -2
- package/lib/tools/keyboard.js.map +1 -1
- package/lib/tools/navigate.js +2 -1
- package/lib/tools/navigate.js.map +1 -1
- package/lib/tools/network.js +225 -8
- package/lib/tools/network.js.map +1 -1
- package/lib/tools/scanPageMatrix.js +134 -43
- package/lib/tools/scanPageMatrix.js.map +1 -1
- package/lib/tools/screenshot.js +3 -3
- package/lib/tools/screenshot.js.map +1 -1
- package/lib/tools/snapshot.js +269 -8
- package/lib/tools/snapshot.js.map +1 -1
- package/lib/tools/tool.js.map +1 -1
- package/lib/tools/utils.js +62 -6
- package/lib/tools/utils.js.map +1 -1
- package/lib/tools.js +5 -2
- package/lib/tools.js.map +1 -1
- package/lib/utils/dataUrl.js +58 -35
- package/lib/utils/dataUrl.js.map +1 -1
- package/lib/utils/jsSource.js +187 -0
- package/lib/utils/jsSource.js.map +1 -0
- package/lib/vscode/browserContextFactory.js +83 -0
- package/lib/vscode/browserContextFactory.js.map +1 -0
- package/lib/vscode/host.js +16 -1
- package/lib/vscode/host.js.map +1 -1
- package/lib/vscode/main.js +1 -33
- package/lib/vscode/main.js.map +1 -1
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -120,6 +120,7 @@ Interactive mode. Type "<tool-name> <json>" to call a tool. Ctrl+D to exit.
|
|
|
120
120
|
> browser_navigate {"url": "https://example.com"}
|
|
121
121
|
> scan_page {"violationsTag": ["wcag21aa"]}
|
|
122
122
|
> audit_keyboard {"maxTabs": 30}
|
|
123
|
+
> audit_screen_reader {}
|
|
123
124
|
```
|
|
124
125
|
|
|
125
126
|
Each line is `<tool-name> <json-arguments>`. Omit the JSON to pass `{}`.
|
|
@@ -217,20 +218,92 @@ Create a `config.json` file with the following options:
|
|
|
217
218
|
- `browser.cdpTimeout`: Maximum time in milliseconds to wait when connecting to the CDP endpoint (default: `30000`)
|
|
218
219
|
- `browser.cdpLaunch`: Launch a Chromium-family desktop app with CDP enabled, wait for the endpoint, and manage the child process lifecycle
|
|
219
220
|
- CDP attach modes preserve the target browser's existing default-context settings instead of applying Playwright's defaults.
|
|
221
|
+
- `browser.contextOptions.storageState`: Start each session from a recorded Playwright storage state; applied in every mode except `--extension` (fresh contexts receive it at creation, reused contexts via `setStorageState()`). Sessions that share one reused context (non-isolated CDP modes) get the state applied once per context — a session joining a live context inherits its current state, not a fresh copy of the file; see [Auditing pages behind a login](#auditing-pages-behind-a-login)
|
|
220
222
|
- `timeouts.navigationTimeout`: Maximum time for page navigation in milliseconds (default: `60000`)
|
|
221
223
|
- `timeouts.defaultTimeout`: Default timeout for Playwright operations in milliseconds (default: `5000`)
|
|
222
|
-
- `timeouts.settle`: How long to wait after
|
|
224
|
+
- `timeouts.settle`: How long to wait after every action before responding (default: `500`). An action that finishes quietly is first watched for up to 100ms (or the settle delay, whichever is shorter) so scheduled network work can still be awaited before the settle delay.
|
|
223
225
|
- `network.allowedOrigins`: List of origins to allow (blocks all others if specified)
|
|
224
226
|
- `network.blockedOrigins`: List of origins to block
|
|
225
227
|
|
|
226
228
|
CLI equivalents are also available: `--cdp-launch-command`, `--cdp-launch-args`, `--cdp-launch-cwd`, `--cdp-launch-port`, `--cdp-launch-startup-timeout`, `--cdp-endpoint`, `--cdp-header` (repeat for multiple headers, e.g. `--cdp-header "Authorization: Bearer <token>"`), and `--cdp-timeout`. The CDP headers and timeout can also be set via the `PLAYWRIGHT_MCP_CDP_HEADERS` (one `Name: Value` entry per line) and `PLAYWRIGHT_MCP_CDP_TIMEOUT` environment variables.
|
|
227
229
|
|
|
228
|
-
Use `--timeout-settle` or `PLAYWRIGHT_MCP_TIMEOUT_SETTLE` to override the post-action settle delay.
|
|
230
|
+
Use `--timeout-settle` or `PLAYWRIGHT_MCP_TIMEOUT_SETTLE` to override the post-action settle delay. It applies after every action so delayed DOM-only updates are included in the response; a short observation window also catches scheduled requests and waits for them before that delay.
|
|
229
231
|
|
|
230
232
|
#### HTTP Heartbeat
|
|
231
233
|
|
|
232
234
|
When the server runs with `--port`, it sends MCP heartbeat pings for Streamable HTTP sessions. Set `PLAYWRIGHT_MCP_PING_TIMEOUT_MS` to override the default `5000` ms timeout. Set it to `0` or any negative value to disable heartbeat pings for clients or proxies that do not answer server-initiated pings.
|
|
233
235
|
|
|
236
|
+
## Auditing pages behind a login
|
|
237
|
+
|
|
238
|
+
Most real audits target pages that only exist for a signed-in user. There are two ways to get there.
|
|
239
|
+
|
|
240
|
+
### Interactive route (no setup)
|
|
241
|
+
|
|
242
|
+
Every tool shares one browser context, and `audit_site` crawls in a temporary tab of that same context, so cookies and local storage created while you drive the browser are already available to the crawl:
|
|
243
|
+
|
|
244
|
+
```text
|
|
245
|
+
1. browser_navigate to the login page
|
|
246
|
+
2. browser_fill_form / browser_click to sign in
|
|
247
|
+
3. browser_navigate to the first page you want audited
|
|
248
|
+
4. audit_site — the crawl inherits the session you just created
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
This works out of the box in every mode, including the default persistent-profile mode. With the default profile the session also survives across server restarts, so you usually only sign in once.
|
|
252
|
+
|
|
253
|
+
### Storage state route (repeatable, CI-friendly)
|
|
254
|
+
|
|
255
|
+
Record a session once with Playwright's codegen, then hand the file to the server:
|
|
256
|
+
|
|
257
|
+
```bash
|
|
258
|
+
npx playwright@1.62.1 codegen --save-storage=auth.json https://example.com/login
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
Sign in in the opened browser, then close it — `auth.json` now holds the cookies and local storage.
|
|
262
|
+
|
|
263
|
+
Pass it to the server with the CLI flag, the environment variable, or the config file:
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
npx mcp-accessibility-scanner --isolated --storage-state ./auth.json
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
```bash
|
|
270
|
+
PLAYWRIGHT_MCP_ISOLATED=true PLAYWRIGHT_MCP_STORAGE_STATE=./auth.json npx mcp-accessibility-scanner
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
```json
|
|
274
|
+
{
|
|
275
|
+
"browser": {
|
|
276
|
+
"isolated": true,
|
|
277
|
+
"contextOptions": {
|
|
278
|
+
"storageState": "./auth.json"
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
> **Every supported mode handles the state — by applying it or refusing it.**
|
|
285
|
+
>
|
|
286
|
+
> - **Fresh-context modes** (`--isolated`, the remote-endpoint mode, or either CDP mode combined with `--isolated`): the context is created with the storage state directly.
|
|
287
|
+
> - **Default persistent-profile mode with `--storage-state`**: the session runs in a fresh, disposable profile — unique to that session and removed when it closes — built from the state, so the recorded state is provably the only session data (without `--storage-state` the regular persistent profile is used and survives restarts, as before). Any page the launch opened (for example from a URL in `browser.launchOptions.args`) is parked on a blank replacement before the state lands, then the replacement is navigated to the same URL, so a still-running anonymous page cannot overwrite the recorded identity and a scan never reads its DOM. This also means `--storage-state` cannot be combined with `--user-data-dir` (a user-supplied profile carries its own session and will not be wiped; the server refuses the combination).
|
|
288
|
+
> - **CDP modes without `--isolated`**: the state is installed into the browser's existing context with Playwright's `setStorageState()`. Cookies are fully reset; origin storage (localStorage/IndexedDB) is reset for the origins recorded in the state *plus* any origins the Playwright connection has already seen — including pages open in the attached browser at connect time, whose storage can therefore be cleared even when the state omits them. Only origins from the profile's earlier history that this connection never saw survive untouched — cut in both directions, so treat an attached browser's storage as neither fully preserved nor fully reset, and add `--isolated` when you need a clean, fully-defined session. Pages already open in the attached browser are replaced with fresh tabs navigated to the same URLs so a scan never sees the previous identity's UI — and the old pages close *before* the state is installed, because a still-running page could otherwise persist the previous identity back into the freshly applied cookies or localStorage, which no later tab replacement could undo. A fresh tab also starts with empty per-tab `sessionStorage` (which sits outside Playwright storage states and would survive an in-place reload, where the old page's own scripts could even write the previous identity back between a clear and the reload), a replacement that fails to load is left blank or closed rather than left on a stale document, and these navigations run under a configured `--allowed-origins`/`--blocked-origins` policy just like every later navigation. The state is applied once per shared context: concurrent MCP sessions attached without `--isolated` share the browser's context, so a session joining while another is active inherits that context's live state (including anything the first session changed or cleared) rather than a fresh copy of the recorded file — add `--isolated` when every session must start from the recorded baseline.
|
|
289
|
+
> - **`--extension`** (with or without `--isolated`) is the one exception: it works through the browser you are already running, where wiping cookies to install a recorded state is not an acceptable side effect, so the server refuses to start rather than doing that silently. There, sign in interactively instead — the persistent profile also keeps the session across restarts.
|
|
290
|
+
|
|
291
|
+
### Keep the crawl from destroying its own session
|
|
292
|
+
|
|
293
|
+
`audit_site` excludes `logout|signout` by default, which is not enough for most applications. Add anything else that ends or changes the session before you start the crawl:
|
|
294
|
+
|
|
295
|
+
```json
|
|
296
|
+
{
|
|
297
|
+
"excludePathPatterns": ["logout|signout", "account/(close|delete)", "sessions/revoke", "/switch-(locale|account|org)"]
|
|
298
|
+
}
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
Note that `excludePathPatterns` replaces the default rather than extending it, so repeat `logout|signout` in your list.
|
|
302
|
+
|
|
303
|
+
If a session cookie disappears anyway, `audit_site` says so instead of reporting a confident, wrong audit: the result starts with a `WARNING: cookie(s) … disappeared while loading <url>` line, and both the JSON report and the structured content carry a `sessionLosses` list naming, for each lost cookie, the page that dropped it — the page reached after any redirect, and reported even when that page failed to finish loading. If one of the lost cookies was the session, every page scanned after that point was audited as a signed-out user — exclude the offending URL, sign in again, and re-run.
|
|
304
|
+
|
|
305
|
+
The check compares which cookies the crawled URLs carry, not their values, so a rotating CSRF token never reads as a lost session. A cookie the browser deleted at its own stated expiry is ignored for the same reason — Cloudflare's `__cf_bm` lives 30 minutes and would otherwise warn on any longer crawl. Beyond that no attempt is made to tell an authentication cookie from any other: nothing in a cookie marks it as one, so any cookie the crawl started with and later lost is reported. Monitoring does not stop at the first loss — each cookie is reported once, at the URL where it vanished, so an analytics cookie expiring early cannot mask the session cookie being dropped later. URLs discovered mid-crawl join the cookie tracking before they are visited, so a session cookie scoped to a path below the start URL (say `/app`) is watched too.
|
|
306
|
+
|
|
234
307
|
## Available Tools
|
|
235
308
|
|
|
236
309
|
The MCP server provides comprehensive browser automation and accessibility scanning tools:
|
|
@@ -242,11 +315,57 @@ Performs a comprehensive accessibility scan on the current page using Axe-core.
|
|
|
242
315
|
|
|
243
316
|
**Parameters:**
|
|
244
317
|
- `violationsTag`: Array of WCAG/violation tags to check
|
|
318
|
+
- `includeIncomplete` (default `true`): also report Axe "incomplete" results
|
|
319
|
+
- `maxNodesPerViolation` (default `10`): cap on nodes reported per rule
|
|
320
|
+
- `includeSelectors` / `excludeSelectors`: CSS selectors that scope the scan
|
|
321
|
+
- `withRules` / `disableRules`: Axe rule ids that narrow which rules run
|
|
322
|
+
- `annotateScreenshot` (default `false`): capture an annotated screenshot of the violations
|
|
323
|
+
|
|
324
|
+
**Annotated screenshots:**
|
|
325
|
+
When `annotateScreenshot` is `true`, each violating element is outlined and labelled with the rule ids it failed, a full-page PNG is written to the MCP output directory (`scan-page-annotated-{timestamp}.png`) and returned as a resource link, and the markers are then removed so the page is left exactly as it was. The markers are drawn in an out-of-flow overlay clipped to each element's own box, so they never reflow the page. The overlay uses a fresh id per scan, is placed in the browser's top layer so it stays visible over an open dialog, popover or fullscreen element, and compensates for a CSS `zoom` or a scaled ancestor so markers line up with what is rendered.
|
|
326
|
+
An element that fails several rules gets one box listing every rule id, and elements inside open shadow roots are marked by walking the shadow path Axe reports.
|
|
327
|
+
Running animations are paused before the elements are measured and resumed after the capture, so a moving target keeps its marker. The markers themselves live in a shadow root under an overlay whose own styles are `!important`, so page CSS cannot restyle or hide what the report counts, and each rule label sits outside the clipped box so it stays readable on an element smaller than its own label.
|
|
328
|
+
At most 50 elements are annotated per scan. The result text always reports how many nodes were marked out of the total, plus how many were left out because they exceeded the limit, were hidden, zero-size or off-canvas (a full-page screenshot is clipped to the document box), or were inside an iframe (cross-frame selectors cannot be resolved from the top document).
|
|
245
329
|
|
|
246
330
|
**Supported Violation Tags:**
|
|
247
|
-
- WCAG standards: `wcag2a`, `wcag2aa`, `wcag2aaa`, `wcag21a`, `wcag21aa`, `wcag21aaa`, `wcag22a`, `wcag22aa`, `wcag22aaa`
|
|
248
|
-
- Section 508: `section508`
|
|
249
|
-
- Categories: `cat.aria`, `cat.color`, `cat.forms`, `cat.keyboard`, `cat.language`, `cat.name-role-value`, `cat.parsing`, `cat.semantics`, `cat.sensory-and-visual-cues`, `cat.structure`, `cat.tables`, `cat.text-alternatives`, `cat.time-and-media`
|
|
331
|
+
- WCAG standards (in the default set): `wcag2a`, `wcag2aa`, `wcag2aaa`, `wcag21a`, `wcag21aa`, `wcag21aaa`, `wcag22a`, `wcag22aa`, `wcag22aaa`
|
|
332
|
+
- Section 508 (in the default set): `section508`
|
|
333
|
+
- Categories (opt-in): `cat.aria`, `cat.color`, `cat.forms`, `cat.keyboard`, `cat.language`, `cat.name-role-value`, `cat.parsing`, `cat.semantics`, `cat.sensory-and-visual-cues`, `cat.structure`, `cat.tables`, `cat.text-alternatives`, `cat.time-and-media`
|
|
334
|
+
- Non-conformance tags (opt-in): `best-practice`, `experimental` (see the caveat below -- a few experimental rules also carry a WCAG tag and run by default)
|
|
335
|
+
|
|
336
|
+
The default set is the WCAG and Section 508 tags only, so a default report means "this fails a conformance criterion". Category tags are opt-in for that reason: Axe matches requested tags with OR, so asking for `cat.keyboard` also pulls in best-practice rules such as `region` and `skip-link` that carry both tags. No live conformance rule is lost by leaving them out: the only rules reachable *only* through a `cat.*` tag are `duplicate-id` and `duplicate-id-active`, which Axe marks deprecated because WCAG removed SC 4.1.1. Add `best-practice` (landmark structure, heading order, `tabindex` hygiene) or a `cat.*` tag when you want that broader review.
|
|
337
|
+
|
|
338
|
+
The same OR semantics apply to `experimental`, with one deliberate exception: five experimental rules -- `css-orientation-lock` (SC 1.3.4), `label-content-name-mismatch` (SC 2.5.3), `p-as-heading`, `table-fake-caption` and `td-has-header` (SC 1.3.1) -- also carry a `wcag*` tag and so run in the default set. In Axe, `experimental` describes how settled the heuristic is, not whether the criterion is real, so these are kept rather than filtered out. Adding the `experimental` tag pulls in the remaining experimental rules, which have no conformance tag of their own.
|
|
339
|
+
|
|
340
|
+
**Scan scoping:**
|
|
341
|
+
`scan_page`, `audit_site`, and `scan_page_matrix` accept `includeSelectors` and `excludeSelectors` to limit what Axe looks at. Use `includeSelectors` to audit one component (`["#checkout-form"]`) and `excludeSelectors` to drop third-party noise that pollutes every report (`["#cookie-banner", "iframe.intercom-frame"]`). Exclusions are applied after inclusions, so you can carve a widget out of an included subtree.
|
|
342
|
+
|
|
343
|
+
Selectors are resolved before the scan runs:
|
|
344
|
+
- Syntactically invalid CSS fails the scan, naming the selector.
|
|
345
|
+
- An `includeSelectors` entry that matches nothing fails the scan. Axe on its own would accept a partly-matching include set and quietly scan less than you asked for, so the scanner refuses rather than returning a clean-looking report with half the scope missing.
|
|
346
|
+
- An `excludeSelectors` entry that matches nothing is a no-op, not an error -- a crawl legitimately visits pages that lack the excluded widget.
|
|
347
|
+
|
|
348
|
+
In `audit_site`, selectors apply to every crawled page, so an `includeSelectors` value that is absent from a given page marks *that page* as errored in the report while the crawl continues. Link discovery runs before the scan, so pages reachable only through an errored page are still crawled.
|
|
349
|
+
|
|
350
|
+
**Rule-level control:**
|
|
351
|
+
`scan_page`, `audit_site`, and `scan_page_matrix` accept `withRules` and `disableRules` to pick individual Axe rules instead of whole tag sets. Use `withRules` to re-check one rule after a fix (`["color-contrast"]`) and `disableRules` to mute a rule you have already triaged (`["region"]`). Rule ids are the ones Axe reports (`image-alt`, `color-contrast`, ...); see the [Deque rule reference](https://dequeuniversity.com/rules/axe/).
|
|
352
|
+
|
|
353
|
+
- **`withRules` overrides `violationsTag`.** Axe can run either a rule list or a tag list, never both, so when `withRules` is set the tags are ignored entirely -- `withRules: ["image-alt"]` runs exactly that one rule regardless of `violationsTag`. Rule ids are the more specific request, so they win.
|
|
354
|
+
- **`disableRules` subtracts from whatever is selected.** It applies to `violationsTag` and `withRules` alike. (Axe itself ignores disabled rules once you give it an explicit rule list; the scanner subtracts them up front so the two options mean the same thing together as apart.) Disabling every rule in `withRules` is an error rather than an empty scan.
|
|
355
|
+
- **An explicitly empty `withRules` is an error too.** `withRules: []` selects no rules, and silently falling back to the tag set would run a different scan than the one requested — omit the option to scan by tags instead. Clients that build the list dynamically should drop the key when the list comes out empty.
|
|
356
|
+
- **Unknown rule ids fail the scan, naming the id.** Both options are checked against Axe's rule catalogue before the browser is touched, so a typo is reported as `Unknown Axe rule id(s) in withRules: image-altt` rather than surfacing later as an `frame.evaluate` failure from inside the page. Rule ids apply to a whole run, so `audit_site` and `scan_page_matrix` check them once before they touch the page -- a bad id fails the call outright instead of crawling every URL, or reloading and re-emulating the page, before rejecting the argument.
|
|
357
|
+
|
|
358
|
+
`audit_site` and `scan_page_matrix` record both values in their JSON report metadata, so a stored report can be told apart from a full scan.
|
|
359
|
+
|
|
360
|
+
**Incomplete ("needs review") results:**
|
|
361
|
+
Axe returns `incomplete` for checks it cannot decide on its own -- contrast over a background image or gradient, ambiguous labels, elements it could not fully evaluate. `scan_page`, `audit_site`, and `scan_page_matrix` report these in a section separate from violations so you can resolve them by inspecting the page (screenshot, snapshot, `browser_evaluate`). Set `includeIncomplete: false` to suppress them.
|
|
362
|
+
|
|
363
|
+
**Frames that could not be scanned:**
|
|
364
|
+
Axe is installed into every frame of the page before the scan runs. A frame that navigates mid-injection, or whose renderer does not answer within a second, is left out -- and its contents then contribute no findings. Rather than let that pass as a clean result, all three scan tools print a `WARNING: Axe could not be installed in N frame(s)` block listing the frame URLs, and `audit_site` and `scan_page_matrix` also record them per page and per variant in their JSON reports (`unscannedFrames`) and in `structuredContent`. A frame that was still loading usually succeeds on a re-run; one that fails consistently has to be audited on its own.
|
|
365
|
+
|
|
366
|
+
A nested frame is reported when any frame above it went unscanned, even if its own injection succeeded: Axe reaches a nested document only by relaying through the frames above it, so an outer frame without Axe takes everything below it out of the scan.
|
|
367
|
+
|
|
368
|
+
A frame you scoped out yourself is not reported: with `excludeSelectors: ["iframe.intercom-frame"]` that widget failing to load is the outcome you asked for, not a gap. Scope is resolved through the whole frame chain and across shadow boundaries, so an `includeSelectors` entry naming an ancestor still covers frames nested several levels below it or inside a shadow root, and excluding an outer frame or a shadow host silences everything inside it. Anything the check cannot resolve is reported rather than hidden.
|
|
250
369
|
|
|
251
370
|
### Audit Tools
|
|
252
371
|
|
|
@@ -255,6 +374,7 @@ Crawls and scans multiple internal pages, then aggregates violations across the
|
|
|
255
374
|
- Default strategy: link-based BFS from the current URL
|
|
256
375
|
- Supports `links`, `nav`, `sitemap`, and `provided` URL strategies
|
|
257
376
|
- Always writes a JSON report (default filename: `audit-site-{timestamp}.json`)
|
|
377
|
+
- Warns and records `sessionLosses` if the crawl loses cookies it started with — see [Auditing pages behind a login](#auditing-pages-behind-a-login)
|
|
258
378
|
|
|
259
379
|
**Example flow:**
|
|
260
380
|
```text
|
|
@@ -268,6 +388,7 @@ Runs Axe scans on the same page across viewport/media/zoom variants and compares
|
|
|
268
388
|
- Default variants: baseline, mobile, desktop, forced-colors, reduced-motion, zoom-200
|
|
269
389
|
- Supports custom variants and optional reload between variants
|
|
270
390
|
- Always writes a JSON report (default filename: `scan-matrix-{timestamp}.json`)
|
|
391
|
+
- JSON report and structured result schema `v2` set baseline deltas to `null` when either scan left frames unscanned, because their coverage is not comparable
|
|
271
392
|
|
|
272
393
|
**Example flow:**
|
|
273
394
|
```text
|
|
@@ -279,9 +400,32 @@ Runs Axe scans on the same page across viewport/media/zoom variants and compares
|
|
|
279
400
|
#### `audit_keyboard`
|
|
280
401
|
Audits real keyboard focus behavior by pressing Tab (and optional Shift+Tab) with practical heuristics.
|
|
281
402
|
- Checks skip links, focus visibility, focus jumps, and possible focus traps
|
|
403
|
+
- Checks target size against WCAG 2.2 SC 2.5.8 (`checkTargetSize`, default on)
|
|
404
|
+
- Checks that focus is not entirely obscured, WCAG 2.2 SC 2.4.11 (`checkFocusObscured`, default on)
|
|
282
405
|
- Optional issue screenshots (`screenshotOnIssue`)
|
|
283
406
|
- Always writes a JSON report (default filename: `audit-keyboard-{timestamp}.json`)
|
|
284
407
|
|
|
408
|
+
**Limits of the WCAG 2.2 checks** — these are heuristics, not a conformance verdict:
|
|
409
|
+
- Target size only inspects elements the tab order actually reaches, so pointer-only targets are never measured.
|
|
410
|
+
- Of the SC 2.5.8 exceptions, only *spacing* (a 24px-diameter circle centered on the target must reach neither another
|
|
411
|
+
target's box nor another undersized target's circle) and *inline* (an inline-level target — `inline`, `inline-block`,
|
|
412
|
+
`inline-flex`, … — inside surrounding sentence text, found by walking out through inline wrappers such as `<strong>`
|
|
413
|
+
to the containing block) are evaluated. The *user agent control*, *essential*, and *equivalent* exceptions cannot be
|
|
414
|
+
detected from the DOM, so a target relying on one of them is still reported and needs manual triage.
|
|
415
|
+
- Spacing neighbours use the same pointer-target rule as the focused element, so rendered `:disabled` controls are not
|
|
416
|
+
counted as neighbours, and `contenteditable` regions are counted as targets on both sides.
|
|
417
|
+
- Target size uses the element's bounding box, so an inline target wrapped over several lines is measured as one
|
|
418
|
+
union box rather than per line, and a target whose visible area is cut down by an `overflow` or `clip-path` ancestor
|
|
419
|
+
is measured at its full unclipped size.
|
|
420
|
+
- SC 2.4.11 is the Minimum (AA) level: a focused element is only reported when *every* sampled point of its box is
|
|
421
|
+
covered by other content. Partially covered focus passes here, and the stricter SC 2.4.12 (AAA) is not checked.
|
|
422
|
+
It applies to every focus stop with a rendered box, including elements that are not pointer targets such as iframes.
|
|
423
|
+
- Coverage is measured by hit-testing sample points and then checking that the element hit actually paints (visible,
|
|
424
|
+
non-zero opacity all the way up to the first wrapper shared with the focused element, non-transparent background or
|
|
425
|
+
background image). A transparent click-catching overlay therefore does *not* count as obscuration, but a covering
|
|
426
|
+
layer with `pointer-events: none` is never returned by hit testing and is missed. Semi-transparent overlays that
|
|
427
|
+
still leave content legible are reported.
|
|
428
|
+
|
|
285
429
|
**Example flow:**
|
|
286
430
|
```text
|
|
287
431
|
1. Navigate to the target page and let it fully load
|
|
@@ -289,6 +433,37 @@ Audits real keyboard focus behavior by pressing Tab (and optional Shift+Tab) wit
|
|
|
289
433
|
3. Review focus findings and open the generated JSON report path
|
|
290
434
|
```
|
|
291
435
|
|
|
436
|
+
#### `audit_screen_reader`
|
|
437
|
+
Audits what a screen reader actually announces, using the browser's own accessibility tree (`page.ariaSnapshot`) plus element geometry. No screen reader is installed or driven; this is a static reading of the exposed tree.
|
|
438
|
+
|
|
439
|
+
**Checks (`checkNames`)**
|
|
440
|
+
- `missing-accessible-name`: controls and images exposed with no accessible name (WCAG 4.1.2)
|
|
441
|
+
- `uninformative-accessible-name`: names such as "click here", "read more", "image" that mean nothing out of context (WCAG 2.4.4)
|
|
442
|
+
- `filename-as-accessible-name`: image alt text that is a file name, e.g. `IMG_1234.jpg`, `DSC00123` (WCAG 1.1.1). Only images are checked: a link or button legitimately named after the file it downloads (`logo.png`) is not a defect.
|
|
443
|
+
- `label-in-name-mismatch`: the accessible name does not contain the visible label, which breaks voice control (WCAG 2.5.3). The visible label of `<input type="submit|button|reset">` is read from its `value`, and a web component's label is read from its open shadow root.
|
|
444
|
+
- `duplicate-accessible-name`: sibling links with the same name that lead to different URLs (WCAG 2.4.4)
|
|
445
|
+
|
|
446
|
+
**Check (`checkReadingOrder`)**
|
|
447
|
+
- `reading-order-mismatch`: accessibility tree order (what is read) versus visual position (WCAG 1.3.2), i.e. `order`, `flex-direction: row-reverse`, absolute positioning
|
|
448
|
+
|
|
449
|
+
**What it deliberately does not detect**
|
|
450
|
+
- Reading order is only compared between siblings that form a single row or a single column. Genuine two-dimensional layouts (grid, CSS multi-column, wrapped flex) have no single correct linear order and are skipped rather than guessed.
|
|
451
|
+
- Elements are excluded from the reading-order comparison when they render no text, are `aria-hidden`, floated, `position: fixed`, off-canvas, or clipped to 1px, because their visual position is decoupled from source order by design. Tolerance: two boxes count as swapped only when they are fully separated along the compared axis (1px), and right-to-left containers are compared right-to-left.
|
|
452
|
+
- Duplicate names are only reported when the destinations differ *and* are observable, which today means resolved link URLs (`/help` and `https://site/help` are the same destination). Two `Save` submit buttons in one form are never called ambiguous, because nothing in the exposed tree says whether they do different things.
|
|
453
|
+
- Only elements the AI snapshot gives a `ref` are analyzed, and Playwright refs the elements that are visible and receive pointer events. A control that is announced but not interactable (`pointer-events: none`, some off-canvas widgets) is therefore skipped: without a ref it cannot be measured, so neither its `aria-hidden` state nor a selector to fix it can be established, and reporting it would mostly surface decorative `aria-hidden` icons.
|
|
454
|
+
- Heading levels and landmark structure are not checked; axe already reports those (`heading-order`, `region`, `landmark-one-main`), so use `scan_page` for them.
|
|
455
|
+
- Findings for names overlap with axe rules such as `link-name`, `button-name` and `image-alt`; this tool adds the quality checks (generic names, file names, label-in-name, duplicates) that axe cannot make.
|
|
456
|
+
- It reports the page as currently rendered. Content behind a collapsed panel or another viewport is judged in that state.
|
|
457
|
+
|
|
458
|
+
**Bounds:** `maxElements` (default 400) caps how many *screen-reader-reachable* accessibility tree elements are analyzed. The snapshot also refs `aria-hidden` subtrees, which no check reports, so measuring continues past them until the budget is filled with reachable elements (up to a hard ceiling of twice `maxElements` measured, so a page built mostly of hidden refs stays bounded). `maxFindingsPerCheck` (default 20) caps the findings listed per check. Both truncations are stated in the summary and the JSON report, and the full counts are always reported. Always writes a JSON report (default filename: `audit-screen-reader-{timestamp}.json`).
|
|
459
|
+
|
|
460
|
+
**Example flow:**
|
|
461
|
+
```text
|
|
462
|
+
1. Navigate to the target page and let it fully load
|
|
463
|
+
2. Run audit_screen_reader (optionally raise maxElements for a large page)
|
|
464
|
+
3. Fix the reported elements by ref, then re-run to confirm
|
|
465
|
+
```
|
|
466
|
+
|
|
292
467
|
### Navigation Tools
|
|
293
468
|
|
|
294
469
|
#### `browser_navigate`
|
|
@@ -337,6 +512,13 @@ Hover over element on page.
|
|
|
337
512
|
Perform drag and drop between two elements.
|
|
338
513
|
- Parameters: `startElement`, `startRef`, `endElement`, `endRef`
|
|
339
514
|
|
|
515
|
+
#### `browser_drop`
|
|
516
|
+
Simulate an external drag and drop of files or clipboard-like data onto an element, for testing drop zones that never see a drag start inside the page.
|
|
517
|
+
- Parameters: `element`, `ref`, `paths` (optional array of absolute file paths), `data` (optional map of mime type to value, e.g. `{"text/plain": "hello"}`)
|
|
518
|
+
- At least one of `paths` or `data` is required.
|
|
519
|
+
- Fails if the target's `dragover` handler does not accept the payload.
|
|
520
|
+
- `paths` are read from the filesystem of the machine running the server, exactly as `browser_file_upload` does, and a relative path resolves against the server's working directory. Unlike `browser_file_upload` this needs no file chooser to be open, so any page with a `dragover` handler is a valid target — treat it as a tool that can hand local file contents to the page.
|
|
521
|
+
|
|
340
522
|
#### `browser_select_option`
|
|
341
523
|
Select an option in a dropdown.
|
|
342
524
|
- Parameters: `element`, `ref`, `values` (array)
|
|
@@ -352,12 +534,15 @@ Press a key on the keyboard.
|
|
|
352
534
|
#### `browser_evaluate`
|
|
353
535
|
Evaluate a JavaScript expression on the page, or on a specific element when a `ref` is provided. The function's return value is serialized back as the result.
|
|
354
536
|
- Parameters: `function` (e.g., `() => document.title` or `(element) => element.textContent`), `element` (optional), `ref` (optional)
|
|
537
|
+
- `element` and `ref` must be supplied together, or not at all; supplying one without the other is rejected.
|
|
538
|
+
- A bare expression is also accepted and is wrapped automatically: `document.title` behaves like `() => document.title`, and, when `element` and `ref` are both given, `element.textContent` behaves like `(element) => element.textContent`. The parameter is always named `element`.
|
|
539
|
+
- Whether the input is a function or an expression is decided from its source form, never from what it evaluates to, so an expression such as `window.open` is returned rather than called.
|
|
355
540
|
|
|
356
541
|
### Screenshot & Visual Tools
|
|
357
542
|
|
|
358
543
|
#### `browser_take_screenshot`
|
|
359
544
|
Take a screenshot of the current page.
|
|
360
|
-
- Parameters: `filename` (optional), `type` (`png` or `
|
|
545
|
+
- Parameters: `filename` (optional), `type` (`png`, `jpeg`, or `webp`), `scale` (`css` or `device`, default `css`), `fullPage` (optional), `element`/`ref` pair (for element screenshots)
|
|
361
546
|
- `scale: device` captures a high-resolution screenshot using device pixels (accounts for the device pixel ratio); `scale: css` keeps the image sized in CSS pixels.
|
|
362
547
|
|
|
363
548
|
#### `browser_pdf_save`
|
|
@@ -392,8 +577,20 @@ Returns all console messages from the page.
|
|
|
392
577
|
Large `data:` URL payloads in console messages are truncated to their media type prefix.
|
|
393
578
|
|
|
394
579
|
#### `browser_network_requests`
|
|
395
|
-
Returns all network requests since loading the page
|
|
580
|
+
Returns all network requests since loading the page, numbered so a single one can be inspected with `browser_network_request`.
|
|
396
581
|
Large `data:` URL payloads in request URLs are truncated to their media type prefix.
|
|
582
|
+
When there is at least one request, a closing line points at `browser_network_request`.
|
|
583
|
+
|
|
584
|
+
#### `browser_network_request`
|
|
585
|
+
Returns the request headers, request body, response headers and response body of one request from the `browser_network_requests` listing.
|
|
586
|
+
- Parameters: `index` (the number shown in the listing, starting at 1)
|
|
587
|
+
- The listing is cleared by `browser_navigate` and when the tab closes; other navigations (link clicks, form submits, `history` calls) leave it in place and keep appending. Re-run `browser_network_requests` to get current indexes.
|
|
588
|
+
- Credential-bearing headers (`authorization`, `proxy-authorization`, `cookie`, `set-cookie`, `x-api-key`, `x-auth-token`) are reported as `<redacted, N characters>`, so their presence and size stay visible but the secret never reaches the transcript. All other headers are reported in full, one line each.
|
|
589
|
+
- Binary request and response bodies are reported as `<binary data, N bytes, mime/type>` rather than dumped. The type decides: `text/*`, `+json`/`+xml` suffixes and known textual types are text; `image/`, `audio/`, `video/`, `font/`, `model/` and known binary types are binary; anything else (`multipart/form-data`, custom types, a missing type) is decided by inspecting the bytes.
|
|
590
|
+
- Textual bodies are decoded using the charset in `content-type`, and are truncated at 20000 characters with a trailing note. The cap applies to the request body and the response body separately, so one call can return up to two truncated bodies.
|
|
591
|
+
- Bodies are wrapped in a code fence, so page-controlled content cannot forge the report's own section headings.
|
|
592
|
+
- A request that failed after its response arrived reports both the status and the failure.
|
|
593
|
+
- Sections that could not be read are reported in place (`<headers unavailable: ...>`, `<body unavailable: ...>`) rather than failing the whole call; reads are bounded by the default timeout, so a still-streaming response cannot hang the tool.
|
|
397
594
|
|
|
398
595
|
### Utility Tools
|
|
399
596
|
|
|
@@ -404,6 +601,7 @@ Wait for text to appear/disappear or time to pass.
|
|
|
404
601
|
#### `browser_handle_dialog`
|
|
405
602
|
Handle browser dialogs (alerts, confirms, prompts).
|
|
406
603
|
- Parameters: `accept` (boolean), `promptText` (optional)
|
|
604
|
+
- If the dialog was already closed outside the session (e.g. dismissed manually in a headed browser), the call succeeds, reports the dialog as already closed, and clears its leftover state instead of failing.
|
|
407
605
|
|
|
408
606
|
#### `browser_file_upload`
|
|
409
607
|
Upload files to the page.
|
|
@@ -504,6 +702,33 @@ cd mcp-accessibility-scanner
|
|
|
504
702
|
npm install
|
|
505
703
|
```
|
|
506
704
|
|
|
705
|
+
### Benchmarking tool latency
|
|
706
|
+
|
|
707
|
+
`bench/mcp-bench.mjs` measures what a client actually waits for: it serves a fixed
|
|
708
|
+
synthetic site, speaks MCP to the built server over stdio, and times real
|
|
709
|
+
`tools/call` round trips for navigation, interaction, snapshots and every audit
|
|
710
|
+
tool. Build first — it runs the compiled server from `lib/`.
|
|
711
|
+
|
|
712
|
+
```bash
|
|
713
|
+
npm run build
|
|
714
|
+
npm run bench -- --out after.json --label after
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
Useful flags: `--iterations <n>` and `--warmups <n>` (defaults 5 and 1),
|
|
718
|
+
`--browser`/`--executable-path` when the browser lives outside Playwright's own
|
|
719
|
+
download directory, and `--server <path/to/cli.js>` plus `--lib <path/to/lib>`
|
|
720
|
+
(supplied together) to point at a different build — that is how revisions compare:
|
|
721
|
+
|
|
722
|
+
```bash
|
|
723
|
+
git worktree add /tmp/baseline main && (cd /tmp/baseline && npm install && npm run build)
|
|
724
|
+
npm run bench -- --server /tmp/baseline/cli.js --lib /tmp/baseline/lib --out before.json --label before
|
|
725
|
+
npm run bench -- --out after.json --label after
|
|
726
|
+
npm run bench:compare -- before.json after.json
|
|
727
|
+
```
|
|
728
|
+
|
|
729
|
+
The comparison total uses only end-to-end scenarios present in both reports,
|
|
730
|
+
so adding or removing a scenario does not distort the reported speedup.
|
|
731
|
+
|
|
507
732
|
## License
|
|
508
733
|
|
|
509
734
|
MIT
|