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

Die folgende Konfiguration kann entweder auf Projektebene oder auf Benutzereinstellungsebene (über alle Projekte hinweg) verwendet werden. Für die Konfiguration auf Projektebene erstellen Sie eine .vscode/mcp.json -Datei in Ihrem Arbeitsbereich. Für eine Benutzereinstellungskonfiguration fügen Sie Ihrem bestehenden Benutzerkonfigurationsdatei einen MCP-Server hinzu.

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

Hinweis: Die Konfiguration verwendet "AXE_API_KEY": "${input:axe-api-key}" für sicheres Eingabemanagement. Dies wird Sie bei der erstmaligen Serverstart nach Ihrem API-Schlüssel fragen. Für weitere Informationen zur VS Code MCP-Konfiguration siehe die VS Code MCP-Dokumentation.

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

Wenn dies weggelassen wird, verwendet der Server standardmäßig https://axe.deque.com (Deques geteilte US SaaS-Instanz). Siehe Konfigurationsoptionen für Details.

info

Für eine vollständige Liste der konfigurierbaren Optionen siehe den Abschnitt Konfigurationsoptionen .

Verwendung der OAuth 2.0-Authentifizierung

Wenn Sie OAuth gegenüber einem API-Schlüssel bevorzugen, ersetzen Sie die obenstehende Konfiguration durch die folgende. Dies verwendet @deque/axe-auth token , um bei jedem Serverstart ein neues Zugriffstoken zu erhalten. Kein inputs Block ist erforderlich — das Token wird automatisch aus dem System-Schlüsselbund abgerufen.

Bevor Sie die Konfiguration vornehmen, erledigen Sie Schritt 1: Authentifizieren im OAuth 2.0-Authentifizierungsleitfaden.

{
  "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"
      ]
    }
  }
}
note

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

"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 dies weggelassen wird, verwendet der Server standardmäßig https://axe.deque.com (Deques geteilte US SaaS-Instanz). Siehe Konfigurationsoptionen für Details.

note

Diese Konfiguration verwendet sh -c , um die Shell-Ersetzung zu ermöglichen. $(npx -y @deque/axe-auth token) läuft beim Serverstart und injiziert ein gültiges Zugriffstoken in den Docker-Container. Der -y Flag überspringt die Erstanfrage „Ok to proceed?“, die npx sonst in einer nicht-interaktiven Shell stellen würde. Setzen Sie nicht AXE_API_KEY zusammen mit AXE_ACCESS_TOKEN.

caution

Windows-Benutzer: Diese Konfiguration verwendet eine POSIX-Shell (sh) und Befehlsersetzung ($(...)), die standardmäßig nicht in cmd.exe oder PowerShell verfügbar sind. Starten Sie VS Code aus einer Git Bash oder einer WSL-Shell, damit sh in Ihrem PATH.

MCP-Server starten

  1. Öffnen Sie VS Code mit Ihren konfigurierten Einstellungen
  2. Suchen Sie den "axe-mcp-server" -Eintrag in Ihrer mcp.json -Datei
  3. Klicken Sie auf die **Start** -Taste, die oberhalb der Serverkonfiguration erscheint
  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

Is this page helpful?

Help us improve this page

Still need help?