Einrichtung in VS Code mit Copilot

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

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.

note

Verwenden Sie eine regionale, private Cloud oder eine lokale Axe-Instanz? Fügen Sie AXE_SERVER_URL dem env-Block mit der Basis-URL Ihrer Instanz hinzu:

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

Falls weggelassen, verwendet der Server standardmäßig https://axe.deque.com (Deque's geteilte US SaaS-Instanz). Details finden Sie unter Konfigurationsreferenz.

OAuth 2.0

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

Starten Sie den Server über @deque/axe-auth run, wodurch das Zugriffstoken des laufenden Servers für die Dauer der Sitzung aktuell bleibt. Kein inputs-Block ist erforderlich – die Anmeldedaten werden automatisch aus Ihrem Systemschlüsselbund abgerufen.

{
  "servers": {
    "axe-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@deque/axe-auth",
        "run",
        "--",
        "docker",
        "run",
        "--add-host=host.docker.internal:host-gateway",
        "-i",
        "--rm",
        "-p",
        "127.0.0.1:9223:9223",
        "-e",
        "AXE_ACCESS_TOKEN",
        "-e",
        "AXE_TOKEN_REFRESH_PORT",
        "-e",
        "AXE_TOKEN_REFRESH_SECRET",
        "-e",
        "AXE_TOKEN_REFRESH_HOST=0.0.0.0",
        "dequesystems/axe-mcp-server:latest"
      ],
      "env": {
        "AXE_TOKEN_REFRESH_PORT": "9223"
      }
    }
  }
}
note

Token-Aktualisierung erreichte den axe MCP Server in v1.5.0. npx -y @deque/axe-auth ruft immer das aktuelle CLI ab, aber ein Docker-Image, das vor dieser Version gezogen wurde, hat keinen Aktualisierungslistener für run, um es zu pushen — ziehen Sie es erneut mit docker pull dequesystems/axe-mcp-server:latest.

npx -y @deque/axe-auth run startet den Container und überwacht ihn während der gesamten Sitzung, indem es dem laufenden Server ein frisch erstelltes Zugriffstoken zusendet, bevor das aktuelle abläuft. Ihr Refresh-Token verlässt niemals Ihren Rechner – nur kurzlebige Zugriffstokens erreichen den Server. Das -y-Flag überspringt die Ersteinführungsaufforderung „In Ordnung, fortzufahren?“, die npx ansonsten in einer nicht-interaktiven Shell stellen würde.

Die verbleibenden Flags dienen dazu, das Pushen innerhalb des Containers erreichbar zu machen:

  • -p 127.0.0.1:9223:9223 veröffentlicht den Refresh-Listener des Servers ausschließlich auf dem Host-Loopback und hält ihn von den externen Schnittstellen Ihres Rechners fern.
  • -e AXE_ACCESS_TOKEN, -e AXE_TOKEN_REFRESH_PORT und -e AXE_TOKEN_REFRESH_SECRET leiten die von run generierten Werte in den Container weiter. Geben Sie nur die Namen an, ohne =value — run liefert sie.
  • -e AXE_TOKEN_REFRESH_HOST=0.0.0.0 bindet den Listener an die Netzwerkschnittstelle des Containers. Ein veröffentlichter Port leitet dorthin weiter, anstatt zum Loopback des Containers, sodass die Standard-Loopback-Bindung nicht erreichbar wäre. Das geteilte Geheimnis, nicht die Isolierung des Containers, schützt den Endpunkt.

9223 ist ein Beispiel – jeder freie Port auf Ihrem Rechner funktioniert, solange AXE_TOKEN_REFRESH_PORT und der -p-Veröffentlichungsname denselben benennen. Siehe Token-Refresh-Variablen für die vollständige Referenz.

note

Verwenden Sie eine regionale, private Cloud- oder eine lokale Axe-Instanz? Add AXE_SERVER_URL to the Docker command and to the env block, alongside the refresh port:

"args": [
  "-y",
  "@deque/axe-auth",
  "run",
  "--",
  "docker",
  "run",
  "--add-host=host.docker.internal:host-gateway",
  "-i",
  "--rm",
  "-p",
  "127.0.0.1:9223:9223",
  "-e",
  "AXE_SERVER_URL",
  "-e",
  "AXE_ACCESS_TOKEN",
  "-e",
  "AXE_TOKEN_REFRESH_PORT",
  "-e",
  "AXE_TOKEN_REFRESH_SECRET",
  "-e",
  "AXE_TOKEN_REFRESH_HOST=0.0.0.0",
  "dequesystems/axe-mcp-server:latest"
],
"env": {
  "AXE_TOKEN_REFRESH_PORT": "9223",
  "AXE_SERVER_URL": "https://your-axe-instance.example.com"
}

Verwenden Sie die gleiche URL, die Sie bei der Anmeldung an --server übergeben haben, damit die Tokens, die axe-auth erstellt, von der Instanz kommen, die der Server aufruft. Wenn diese weggelassen wird, verwendet der Server standardmäßig https://axe.deque.com (Deque's geteilte US SaaS-Instanz). Siehe Konfigurationsreferenz für weitere Details.

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

Ihre Konfiguration enthält ein Anmeldedaten im env-Block. Projektbezogene Dateien wie .vscode/mcp.json befinden sich in Ihrem Repository — fügen Sie sie zu .gitignore hinzu oder halten Sie Anmeldedaten stattdessen in Ihrer Benutzerkonfiguration. Siehe Umgang mit Geheimnissen sicher unten.

OAuth 2.0

OAuth 2.0 wird ebenfalls mit der npm-Distribution unterstützt. Wickeln Sie den Server genauso wie oben in @deque/axe-auth run ein – es gibt keinen Container, in den ein Port veröffentlicht werden muss, daher ist der Befehl kürzer:

{
  "servers": {
    "axe-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@deque/axe-auth",
        "run",
        "--",
        "npx",
        "-y",
        "axe-mcp-server"
      ],
      "env": {
        "AXE_TOKEN_REFRESH_PORT": "9223"
      }
    }
  }
}

npx -y @deque/axe-auth run startet den Server und überwacht ihn während der gesamten Sitzung, indem er ein neu ausgestelltes Zugriffstoken an den laufenden Prozess übermittelt, bevor das aktuelle abläuft. Hier ist kein Port-Publish erforderlich: Der umwickelte Prozess erbt AXE_TOKEN_REFRESH_PORT direkt und der Listener bleibt auf Loopback. 9223 ist ein Beispiel – jeder freie Port auf Ihrem Rechner funktioniert, und die Variable ist hier optional: Lassen Sie sie weg und run wählt einen freien Port für die Sitzung aus.

caution

Im Gegensatz zu einem Container erbt die npm-Distribution Ihre gesamte Shell-Umgebung. Wenn AXE_API_KEY dort exportiert wird, erreicht es den Server zusammen mit dem OAuth-Token und der Server verweigert den Start. Entfernen Sie es in der Shell, von der aus Sie Ihren Editor starten, oder verwenden Sie die obenstehende Docker-Konfiguration, die nur die explizit mit -e-Flags übergebenen Variablen erhält.

Siehe Authentifizierung für den vollständigen Ablauf.

note

Setzen Sie entweder AXE_API_KEY oder AXE_ACCESS_TOKEN — nicht beide. Der Server wird beim Start fehlschlagen, wenn beide Variablen gesetzt sind.

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.

Is this page helpful?

Help us improve this page

Still need help?