A11y

An MCP (Model Context Protocol) server for performing accessibility audits on webpages using axe-core. Use the results in an agentic loop with your favorite AI assistants (Amp/Cline/Cursor/GH Copilot) and let them fix a11y issues for you!

javascript

36

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "priyankark-a11y-mcp": {
      "command": "npx",
      "args": [
        "a11y-mcp"
      ]
    }
  }
}

You can run an MCP server to perform automated accessibility audits on webpages using axe-core. This enables you to request audits and summaries through your MCP client, then act on the results to fix issues more efficiently.

How to use

To use the a11y MCP Server, configure your MCP client to connect via the local or remote server you run. You can request two main capabilities: a detailed accessibility audit of a webpage and a concise summary of accessibility issues. Use these capabilities by invoking the corresponding tools in your MCP client, supplying the target URL and any optional flags.

How to install

Prerequisites: You need Node.js and npm installed on your machine.

Install the MCP server globally so you can run it from anywhere.

npm install -g a11y-mcp

Alternatively, you can run the MCP server directly without a global install using npx.

npx a11y-mcp

Configure your MCP client to include the a11y MCP server. Use the following configuration snippet exactly as written to enable the server.

{
  "mcpServers": {
    "a11y": {
      "command": "npx",
      "args": ["a11y-mcp"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

Configuration notes

There is no need for additional environment variables for basic operation. The server is accessed through the MCP client using the configured command and arguments.

Security and usage notes

Run the MCP server in a trusted environment. Only connect MCP clients you control to avoid exposing audit data. If you operate remotely, consider standard security practices for the hosting machine and limit access to trusted networks.

Examples of typical workflows

Audit a webpage for accessibility issues and review the detailed results in your MCP client. Then request a concise summary to quickly understand the scope of issues.

Troubleshooting

If the MCP server does not start, ensure Node.js is installed and that your PATH includes the npm global bin directory after installing with npm install -g a11y-mcp. If using npx, confirm that the a11y-mcp package is available in your npm registry.

Available tools

audit_webpage

Performs a detailed accessibility audit on a webpage. Parameters: url (required), includeHtml (optional, default: false), tags (optional, array of WCAG criteria like wcag2a, wcag2aa, wcag21a, best-practice)

get_summary

Gets a short summary of accessibility issues for a webpage. Parameters: url (required)