axe MCP Server

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Not for use with personal data

Overview

The axe MCP Server is a Model Context Protocol (MCP) server that integrates enterprise-grade accessibility testing directly into your development workflow. Built on the trusted axe platform, it enables developers to perform comprehensive accessibility scans and receive expert remediation guidance without leaving their IDE.

The server provides two primary capabilities:

Analyze Tool: Performs accessibility scans on web pages using axe DevTools
Remediate Tool: Provides expert-level AI-generated remediation guidance for identified accessibility issues

Getting Access

The axe MCP Server is currently available through an early access program. To request access:

Visit the axe MCP Server waitlist page
Complete the form with your information
Our team will contact you when your access is approved

Installation and Setup

Prerequisites

Docker installed and running on your system
AI agent configured for axe MCP Server (see VS Code with Copilot example below)
An active axe DevTools for Web or axe DevTools Extension (Pro) subscription

Step 1: Generate API Key

Log into the axe Account Portal
Navigate to the API Keys page
Click ADD NEW API KEY
Select axe MCP Server as the product
Enter a descriptive name for your API key
Click Save
Copy the generated API key for use in the next step

Step 2: Pull the Docker Image

Initially and any time an updated version is released that you would like to use, you will have to docker pull the axe MCP Server image:

docker pull dequesystems/axe-mcp-server:latest

Step 3: Configuration

VS Code with Copilot

Add the following configuration to your VS Code user settings or project settings (settings.json):

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "axe-api-key",
        "description": "axe MCP Server API Key",
        "password": true
      }
    ],
    "servers": {
      "axe-mcp-server": {
        "command": "docker",
        "args": [
          "run",
          "--add-host=host.docker.internal:host-gateway",
          "-i",
          "--rm",
          "-e",
          "AXE_API_KEY",
          "dequesystems/axe-mcp-server:latest"
        ],
        "env": {
          "AXE_API_KEY": "${input:axe-api-key}"
        }
      }
    }
  }
}

Note: The configuration uses "AXE_API_KEY": "${input:axe-api-key}" for secure input handling. This will prompt you for your API key when the server starts for the first time. For more information about VS Code MCP configuration, see the VS Code MCP documentation.

info

For a full list of configurable options, refer to the Configuration Options section below.

Start the MCP Server

Open VS Code with your configured settings
Locate the "axe-mcp-server" entry in your settings.json
Click the Start button that appears above the server configuration
When prompted, enter your API key from Step 1

Submit Prompts to Copilot

Once the axe MCP Server is running, you can use it through VS Code's Copilot chat interface:

Open Copilot chat in VS Code
Ensure you're in agent mode to allow tool usage
Submit prompts to analyze websites and remediate accessibility issues

Example Prompts

Analyze a localhost URL for accessibility issues:

Analyze http://localhost:3000 for accessibility issues

Analyze and get remediation guidance:

Analyze https://example.com for accessibility issues and provide remediation guidance

Comprehensive analysis with code suggestions:

Analyze https://example.com for accessibility issues and fix any issues found

Configuration Options

The axe MCP Server supports several environment variables for customization:

Env var	Description	Default
`AXE_API_KEY`	The API key to be used to validate your access to the axe MCP Server (see Step 1: Generate API Key above).
`AXE_SERVER_URL`	The URL of your axe Account Portal server	`"https://axe.deque.com"`
`BROWSER_TIMEOUT_MS`	The number of milliseconds we'll allow browser interactions to wait before timing out	`30000`
`LOG_LEVEL`	Follows the Syslog Protocol; supported values are `"debug"`, `"info"`, `"warn"`, and `"error"`	`"info"`

Troubleshooting

Common Issues

Server fails to start:

Ensure Docker is running
Verify your API key is correct
Check that you have access to the axe MCP Server (contact support if needed)

Scan timeouts:

Increase BROWSER_TIMEOUT_MS for complex pages
Ensure the target URL is accessible from your network
Check for network connectivity issues

Authentication errors:

Verify your API key is valid and hasn't expired
Ensure your axe Account Portal subscription includes MCP Server access
Check that the API key was created for "axe MCP Server" product

Docker-related issues:

Ensure Docker daemon is running
Check Docker permissions
Verify network connectivity for Docker image downloads
Ensure docker has enough memory by running a docker system prune

Getting Help

If you encounter issues not covered in this troubleshooting section:

Check the VS Code Developer Console for detailed error messages
Review the Docker container logs for additional debugging information
Contact our support team at helpdesk@deque.com with:
- Your VS Code version
- Docker version
- Complete error messages
- Steps to reproduce the issue