Einrichtung in Claude Code
Der Axe MCP-Server kann entweder auf Projektebene oder Benutzerebene hinzugefügt werden.
Bereich wählen
- Projektebene: Erstellen Sie eine Datei im
.mcp.jsonIhres Projektstammverzeichnisses (am besten zum Teilen von Einstellungen mit einem Team) - Benutzerebene: Fügen Sie den Server zum
mcpServersObjekt in~/.claude.jsonIhrem Home-Verzeichnis hinzu (gilt für alle Ihre Projekte). Sie können benutzerebene Server auch mit demclaude mcp add --scope userBefehl verwalten — siehe die Claude Code MCP-Dokumentation für weitere Details.
Konfigurations-JSON hinzufügen
Fügen Sie das folgende Konfigurations-JSON hinzu.
Wenn Sie bereits andere Server definiert haben, fügen Sie den axe-mcp-server Block innerhalb des vorhandenen mcpServers Objekts hinzu.
{
"mcpServers": {
"axe-mcp-server": {
"type": "stdio",
"command": "docker",
"args": [
"run",
"--add-host=host.docker.internal:host-gateway",
"-i",
"--rm",
"-e", "AXE_SERVER_URL",
"-e", "AXE_API_KEY",
"dequesystems/axe-mcp-server:latest"
],
"env": {
"AXE_SERVER_URL": "https://axe.deque.com",
"AXE_API_KEY": "${AXE_API_KEY}"
}
}
}
}Die Konfiguration verwendet "AXE_API_KEY": "${AXE_API_KEY}" für die sichere Eingabeverarbeitung. Die ${AXE_API_KEY} Syntax weist Claude Code an, den Wert aus Ihrer Shell-Umgebung zu holen. Für weitere Informationen siehe die Claude Code MCP-Dokumentation.
Verwenden Sie eine regionale, private Cloud oder eine lokale Axe-Instanz? Aktualisieren Sie den AXE_SERVER_URL Wert im env Block mit der Basis-URL Ihrer Instanz:
"env": {
"AXE_API_KEY": "${AXE_API_KEY}",
"AXE_SERVER_URL": "https://your-axe-instance.example.com"
}Wenn nicht angegeben, wird der Server auf https://axe.deque.com (Deque's gemeinsame US SaaS-Instanz) standardmäßig gesetzt. Siehe Konfigurationsoptionen für weitere Details.
API-Schlüssel festlegen
Legen Sie Ihren API-Schlüssel als Umgebungsvariable in Ihrer Shell fest:
export AXE_API_KEY="your-api-key-here"Für eine dauerhafte Einrichtung fügen Sie diese Zeile zu Ihrem Shell-Profil hinzu (~/.bashrc, ~/.zshrc, etc.).
OAuth 2.0-Authentifizierung verwenden
Wenn Sie OAuth gegenüber einem API-Schlüssel bevorzugen, ersetzen Sie die obige Konfiguration durch die folgende. Dies verwendet @deque/axe-auth token , um bei jedem Start des Servers ein neues Zugriffstoken zu erhalten.
Bevor Sie konfigurieren, schließen Sie Schritt 1: Authentifizieren im OAuth 2.0-Authentifizierungsleitfaden ab.
{
"mcpServers": {
"axe-mcp-server": {
"type": "stdio",
"command": "sh",
"args": [
"-c",
"docker run --add-host=host.docker.internal:host-gateway -i --rm -e \"AXE_ACCESS_TOKEN=$(npx -y @deque/axe-auth token)\" dequesystems/axe-mcp-server:latest"
]
}
}
}Verwenden Sie eine regionale, private Cloud oder eine lokale Axe-Instanz? Fügen Sie AXE_SERVER_URL dem Docker-Befehl hinzu und einen env Block mit der Basis-URL Ihrer Instanz:
"args": [
"-c",
"docker run --add-host=host.docker.internal:host-gateway -i --rm -e AXE_SERVER_URL -e \"AXE_ACCESS_TOKEN=$(npx -y @deque/axe-auth token)\" dequesystems/axe-mcp-server:latest"
],
"env": {
"AXE_SERVER_URL": "https://your-axe-instance.example.com"
}Wenn nicht angegeben, wird der Server auf https://axe.deque.com (Deque's gemeinsame US SaaS-Instanz) standardmäßig gesetzt. Siehe Konfigurationsoptionen für weitere Details.
Diese Konfiguration verwendet sh -c , um Shell-Ersetzungen zu ermöglichen. $(npx -y @deque/axe-auth token) wird beim Serverstart ausgeführt und injiziert ein gültiges Zugriffstoken in den Docker-Container. Der -y Schalter überspringt die Ersteinsatz-Aufforderung „Ok to proceed?“, die npx ansonsten in einer nicht-interaktiven Shell stellen würde. Setzen Sie nicht AXE_API_KEY zusammen mit AXE_ACCESS_TOKEN.
Windows-Benutzer: Diese Konfiguration verwendet eine POSIX-Shell (sh) und Kommandoersetzung ($(...)), die standardmäßig in cmd.exe oder PowerShell nicht verfügbar ist. Führen Sie Claude Code von einer Git Bash oder einer WSL-Shell aus, damit sh sich in Ihrem PATHbefindet.
Verwendung und Überprüfung
Nach der Konfiguration starten Sie Claude Code neu, um den MCP-Server zu laden.
- Starten Sie Claude Code von Ihrem Terminal:
claude - Geben Sie
/mcpein, um MCP-Serververbindungen zu verwalten - Sie sollten sehen, dass
axe-mcp-servergelistet ist mit denanalyzeund denremediateverfügbaren Werkzeugen
Konfiguration von Claude Code (empfohlen)
Um sicherzustellen, dass Claude Code die Axe MCP Server-Tools korrekt verwendet, fügen Sie die folgenden Anweisungen zu einer CLAUDE.md Datei im Stammverzeichnis Ihres Projekts hinzu. Dies teilt Claude mit, dem korrekten Analyse-dann-Remediate-Workflow zu folgen.
# Accessibility Testing and Remediation Workflow
## MANDATORY WORKFLOW - DO NOT DEVIATE
When working with accessibility issues, you MUST follow this exact workflow:
### 1. Analysis Phase
When asked to analyze pages for accessibility issues, you MUST:
- Use the `analyze` tool to scan the page
- Do NOT manually identify accessibility issues
- Always provide the complete URL being analyzed
### 2. Remediation Phase
When asked to remediate or fix accessibility issues, you MUST:
- First use `remediate` tool for EACH violation found
- Provide the exact HTML element, rule ID, and issue description
- Review the remediation guidance before making any code changes
- Apply fixes based on the remediate tool's recommendations
- Do NOT manually fix accessibility issues without first using the remediate tool
### 3. Verification Phase
After applying fixes, you MUST:
- Re-run `analyze` to verify all issues are resolved
- Confirm zero violations before considering the task completeFür weitere Details zu Agentenanweisungen, siehe Konfiguration Ihres KI-Agenten.
