a11yscan
README.md
# a11yscan
Check a page or a chunk of markup against WCAG without running your own rendering pipeline. a11yscan is a small forwarding client for the hosted LazyNext accessibility checker: the tool list is served from your own machine using the captured definitions, and each call is sent upstream, with the service's answer returned exactly as it arrived.
All four captured tools are exposed. You can render and audit a live page, audit pasted HTML statically without any rendering, fetch a stored report from an earlier scan by its id, and list every WCAG criterion the scanner can emit, with its level and detection path.
## The tools
- **`scan_url`** — Render and audit a live web page for WCAG 2.1/2.2 violations; returns a score, findings, and a shareable report URL. Requires `url`. Optional: `site` to crawl same-origin pages, `viewport` (`mobile` or `desktop`), and `license` — your own Pro license email, forwarded verbatim to raise the free-tier quota under your own allowance; the rebuild never originates or stores it. Free tier is 3 URL scans per day per IP.
- **`scan_html`** — Audit pasted HTML markup (up to 512KB) for WCAG violations using static rules only: no render, no quota. Requires `html`.
- **`get_report`** — Fetch a stored scan report by its id, the slug in the report URL from a prior `scan_url` or `scan_html` result. Requires `id`.
- **`list_rules`** — List every WCAG criterion the scanner can emit, with level and detection path. No arguments, and no required fields.
## Install and run
As an MCP server via npm:
```bash
npx -y @reneturcios/a11yscan mcp
```
MCP client configuration:
```json
{
"mcpServers": {
"a11yscan": {
"command": "npx",
"args": ["-y", "@reneturcios/a11yscan", "mcp"]
}
}
}
```
As a container:
```bash
docker run -i ghcr.io/cloudcorprecords/a11yscan
docker run --rm ghcr.io/cloudcorprecords/a11yscan list_rules '{}'
```
## CLI
A single binary covers both the command line and the MCP server. Every tool is a subcommand whose one argument is a JSON string of that tool's inputs:
```bash
a11yscan scan_url '{"url":"https://example.com"}'
a11yscan scan_url '{"url":"https://example.com","viewport":"desktop"}'
a11yscan scan_html '{"html":"<html><body><p>hi</p></body></html>"}'
a11yscan get_report '{"id":"abc123"}'
a11yscan list_rules '{}'
a11yscan --version
```
Exit codes: `0` for a successful forwarded call, `1` when the result that comes back is an error, and `2` for usage mistakes like an unknown subcommand or a JSON argument that does not parse.
## Configuration
- `LAZYNEXT_MCP_URL` — Replaces the upstream endpoint. Defaults to the pinned hosted endpoint, `https://api.lazynext.com/mcp`. (This override variable is a reconstruction introduced by this rebuild.)
The LazyNext registry record lists no headers for its remote, so a11yscan never attaches an authentication header — every call goes upstream keyless.
When the upstream cannot answer — it returns a JSON-RPC error, answers with a non-2xx status, sends a body that cannot be read, or the request itself fails — the caller receives an error result whose text begins with `a11yscan error:`.
## How forwarding works
The first call of a process opens a session against the upstream: an `initialize` request (protocol version `2025-03-26`), a `notifications/initialized` notification, and then the `tools/call`. If the service issues an `Mcp-Session-Id` header during initialize, a11yscan repeats it on subsequent requests and keeps reusing that one session until the process ends. Replies are understood in both plain JSON and server-sent-events framing. Successful results are passed through untouched, `isError` flag and any extra fields included.
## Development
```bash
npm install
npm run build # tsc -> dist/ (dist/cli.js is the bin)
npm test # tsx --test test/*.test.ts — stubbed upstream, no network
npm run dev # run the CLI from source
```
The suite compares the served tool list against the captured surface tool for tool, walks the session handshake and its reuse, proves no `Authorization` header is sent under any environment, and confirms that arguments — including a caller's own optional `license` — travel upstream unchanged and results return unchanged.
## License
MIT — see `LICENSE`. Copyright (c) 2026 Rene Turcios.
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo recent community issues