A11y

🚀 A11y MCP Server

A Model Context Protocol (MCP) server for web accessibility auditing using axe-core. Combine it with your favorite AI assistant (Cline/Cursor/GH Copilot) and let them fix accessibility issues for you!

🚀 Quick Start

The A11y MCP Server is a powerful tool that uses axe-core to conduct web accessibility audits. It can be seamlessly integrated with popular AI assistants to help you identify and resolve accessibility issues on web pages.

✨ Features

• Conduct detailed accessibility audits on any web page.
• Obtain a summary of accessibility issues.
• Filter audit results by specific WCAG standards.
• Include HTML snippets in the results for easy debugging.

📦 Installation

You can install the A11y MCP Server globally or use it directly with npx.

# Install globally
npm install -g a11y-mcp

# Or use directly with npx
npx a11y-mcp

📚 Documentation

Configuration

To use this MCP server with Cline, you need to add it to your MCP settings configuration file.

MCP Configuration

Add the following content to the mcpServers object:

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

Available Tools

audit_webpage

Conduct a detailed accessibility audit on a web page.

Parameters:

• url (required): The URL of the web page to be audited.
• includeHtml (optional): Whether to include HTML snippets in the results (default: false).
• tags (optional): An array of specific accessibility tags to check (e.g., wcag2a, wcag2aa, wcag21a, best-practice).

Example:

Use the a11y MCP server to audit the accessibility issues of example.com.

get_summary

Obtain a summary of accessibility issues on a web page.

Parameters:

• url (required): The URL of the web page to be audited.

Example:

Give me a summary of the accessibility issues on example.com.

Example Usage

After configuration, you can instruct Claude to use the MCP server to perform accessibility audits:

1. "Can you check if there are any accessibility issues on example.com?"
2. "Audit my website https://mywebsite.com to meet the WCAG 2.1 AA standard."
3. "Give me a summary of the accessibility issues on https://example.com."
4. "Check if there are any critical accessibility issues on my local development server http://localhost:3000."

Development

To run the server locally for development:

npm start

Release

This project includes a release script to assist with version control and publishing to npm. The script handles version increment, running tests, creating Git tags, and publishing to npm.

To release a new version:

# Ensure the script is executable
chmod +x release.sh

# Release a patch version (default)
./release.sh

# Release a minor version
./release.sh --minor

# Release a major version
./release.sh --major

# Release a specific version
./release.sh --version=1.2.3

# Skip Git operations
./release.sh --skip-git

# Dry run (make no changes)
./release.sh --dry-run

# Force release even with uncommitted changes
./release.sh --force

To get more information, run:

./release.sh --help

📄 License

MPL 2.0

🙏 Acknowledgments

This project is built on the outstanding work of axe-core.