Skip to main content

MCP plugin for accessibility testing using Axe-core

Project description

🧪 mcp-axe: Accessibility Testing Plugin using Axe-core

mcp-axe is an MCP-compatible plugin for automated accessibility scanning using Deque's axe-core. It supports both Selenium and Playwright engines and provides a CLI and FastAPI interface for scanning URLs, raw HTML content, and batches — all enriched with screenshot capture and optional reporting.

📦 Installation

Clone this repo and install in editable mode:

#git clone https://github.com/yourname/mcp-axe.git
#cd mcp-axe
python3 -m venv .venv && source .venv/bin/activate
pip install -e .

CLI Usage

Scan a URL

mcp-axe scan-url https://broken-workshop.dequelabs.com --engine selenium --no-headless --save --output-json --output-html

Scan a local HTML file

mcp-axe scan-html path/to/your/file.html --browser chrome --no-headless --save --output-json --output-html

Batch scan multiple URLs:

mcp-axe batch-scan "https://broken-workshop.dequelabs.com,https://google.com" --engine selenium --browser chrome --headless --save --output-json

Summarize a saved report:

mcp-axe summarize report_selenium_chrome.json --output-json --save

API Usage

Run the FastAPI server locally:

uvicorn mcp_axe.api:app --reload --app-dir src

Available Endpoints:

Endpoint Description
POST /scan/url Scan a live URL
POST /scan/html Scan raw HTML content
POST /scan/batch Scan multiple URLs
POST /scan/summarise Summarize violations

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_axe-0.1.0.tar.gz (158.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_axe-0.1.0-py3-none-any.whl (157.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_axe-0.1.0.tar.gz.

File metadata

  • Download URL: mcp_axe-0.1.0.tar.gz
  • Upload date:
  • Size: 158.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for mcp_axe-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e2de27d09b58810ce738dd6b4b9a7d931c0a74ee0135debfc1aa0427146a7eb1
MD5 cc129edda4b577ddee12fded9e1122d1
BLAKE2b-256 be4a4ef0ba5d3e1785087791859db0a8537b40caae1c8af6ebea4244f197f753

See more details on using hashes here.

File details

Details for the file mcp_axe-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: mcp_axe-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 157.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for mcp_axe-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 952e174a21330c9ec53e5c65945bfa1024c44963a749f17bd32a4e8081e33a5c
MD5 eec2e6b7e705753d666de46233f55422
BLAKE2b-256 d394e2dc1ea07339108983f4c561707aa493cdbbe0378e32585062a4f212a022

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page