Einrichtung in VS Code mit Copilot

Bevor Sie mit der Konfiguration beginnen, wählen Sie eine Distribution (Docker oder npm) und richten Sie die Authentifizierung ein (API-Schlüssel oder OAuth 2.0). Fügen Sie dann die passende Konfiguration unten hinzu.

Die Konfiguration kann entweder auf Projektebene oder auf Benutzereinstellungen-Ebene (über alle Projekte hinweg) verwendet werden. Für die Projektebene erstellen Sie eine .vscode/mcp.json-Datei in Ihrem Arbeitsbereich. Für eine Benutzereinstellungen-Ebene fügen Sie einen MCP-Server zu Ihrer bestehenden Benutzerkonfigurationsdatei hinzu. Weitere Informationen finden Sie in der VS Code MCP-Dokumentation.

Docker

API-Schlüssel

{
  "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_SERVER_URL",
        "-e",
        "AXE_API_KEY",
        "dequesystems/axe-mcp-server:latest"
      ],
      "env": {
        "AXE_API_KEY": "${input:axe-api-key}"
      }
    }
  }
}

Die Konfiguration verwendet "AXE_API_KEY": "${input:axe-api-key}" für die sichere Eingabeverarbeitung. Dies wird Sie beim ersten Start des Servers nach Ihrem API-Schlüssel fragen.

"env": {
  "AXE_API_KEY": "${input:axe-api-key}",
  "AXE_SERVER_URL": "https://your-axe-instance.example.com"
}

OAuth 2.0

Bevor Sie konfigurieren, vervollständigen Sie Schritt 1: Authentifizieren im Authentifizierungsleitfaden.

Dies verwendet @deque/axe-auth token, um bei jedem Start des Servers ein neues Zugangstoken zu erhalten. Kein inputs-Block ist nötig — das Token wird automatisch aus Ihrem Systemschlüsselbund abgerufen.

{
  "servers": {
    "axe-mcp-server": {
      "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"
      ]
    }
  }
}

"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"
}

npm

Die npm-Distribution läuft auf Node.js. Verwenden Sie ein aktive LTS-Version von Node.js – ältere Versionen werden möglicherweise nicht unterstützt.

Die npm-Distribution benötigt einen Chromium-Browser — entweder installieren Sie einen über Playwright oder verweisen auf eine vorhandene Binärdatei. Siehe Auswahl einer Distribution.

API-Schlüssel

Erstellen Sie eine .vscode/mcp.json-Datei in Ihrem Arbeitsbereich (Projektebene) oder fügen Sie den Server zu Ihrer Benutzerkonfiguration hinzu:

{
  "servers": {
    "axe-mcp-server": {
      "command": "npx",
      "args": ["-y", "axe-mcp-server"],
      "env": {
        "AXE_API_KEY": "your-api-key-here"
      }
    }
  }
}

OAuth 2.0

OAuth 2.0 wird auch mit der npm-Distribution unterstützt — setzen Sie AXE_ACCESS_TOKEN anstelle von AXE_API_KEY, und injizieren Sie ein neues Token aus @deque/axe-auth token beim Start. Den vollständigen Ablauf finden Sie unter Authentifizierung.

Umgang mit Geheimnissen sicher

Wenn Sie ein Anmeldedaten im env-Block einfügen, behandeln Sie diese Datei wie jede andere Geheimdatei:

• Nie ins Versionierungssystem einchecken. Projektbezogene Dateien wie .vscode/mcp.json befinden sich in Ihrem Repository — fügen Sie sie zu Ihrem .gitignore hinzu, oder halten Sie Anmeldedaten stattdessen in Ihrer Benutzerkonfiguration.
• Bevorzugen Sie Ihre Betriebssystem-Schlüsselbund oder einen Geheimverwaltung wo unterstützt. Für OAuth speichert @deque/axe-auth bereits Tokens in Ihrem Systemschlüsselbund — siehe Authentifizierung.
• Dateiberechtigungen einschränken, sodass nur Ihr Benutzer die Datei lesen kann (zum Beispiel, chmod 600 .vscode/mcp.json auf macOS und Linux).

MCP-Server starten

1. Öffnen Sie VS Code mit Ihren konfigurierten Einstellungen
2. Lokalisieren Sie den "axe-mcp-server"-Eintrag in Ihrer mcp.json-Datei
3. Klicken Sie auf die Schaltfläche **Start**, die über der Serverkonfiguration angezeigt wird
4. Wenn Sie die Authentifizierung mit API-Schlüssel konfiguriert haben, geben Sie Ihren API-Schlüssel ein, wenn Sie dazu aufgefordert werden. Wenn Sie OAuth konfiguriert haben, startet der Server ohne Aufforderung und ruft ein Token aus Ihrem Systemschlüsselbund ab.

Eingaben an Copilot senden

Sobald der axe MCP-Server läuft, können Sie ihn über die Copilot-Chat-Oberfläche von VS Code nutzen:

1. Öffnen Sie den Copilot-Chat in VS Code
2. Stellen Sie sicher, dass Sie sich im Agentenmodus befinden, um die Nutzung von Werkzeugen zu ermöglichen
3. Senden Sie Eingaben, um Websites zu analysieren und Barrierefreiheitsprobleme zu beheben

Für empfohlene benutzerdefinierte Anweisungen, die Copilot durch den Analyse-und-Korrigieren-Workflow führen, siehe Konfiguration Ihres KI-Agenten.