Setup in VS Code met 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

Voordat je configureert, een distributie kiezen (Docker of npm) en authenticatie instellen (API-sleutel of OAuth 2.0). Voeg vervolgens de bijbehorende configuratie hieronder toe.

De configuratie kan op projectniveau of op gebruikersinstellingsniveau (voor alle projecten) worden gebruikt. Voor configuratie op projectniveau, maak een .vscode/mcp.json bestand aan in je werkruimte. Voor een configuratie op gebruikersinstellingsniveau, voeg een MCP-server toe aan je bestaande gebruikersconfiguratiebestand. Voor meer informatie, zie de VS Code MCP-documentatie.

Docker

API-sleutel

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

De configuratie gebruikt "AXE_API_KEY": "${input:axe-api-key}" voor veilige inputverwerking. Dit vraagt om je API-sleutel wanneer de server voor het eerst start.

note

Gebruik je een regionale, private cloud of lokale axe-instantie? Voeg AXE_SERVER_URL toe aan het env blok met de basis-URL van je instantie:

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

Indien weggelaten, valt de server terug op https://axe.deque.com (Deque's gedeelde US SaaS-instantie). Zie Configuratie Referentie voor details.

OAuth 2.0

Voordat u configureert, voltooi Stap 1: Authenticeer in de Authenticatiehandleiding.

Start de server via @deque/axe-auth run, waarmee het toegangstoken van de actieve server vers blijft zolang de sessie duurt. Er is geen inputs-blok nodig — inloggegevens worden automatisch uit de systeemsleutelhanger opgehaald.

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

Tokenvernieuwing bereikte de axe MCP Server in v1.5.0. npx -y @deque/axe-auth haalt altijd de huidige CLI op, maar een Docker-image dat vóór die release is gedownload, heeft geen vernieuwingluisteraar voor run om naar te pushen — download het opnieuw met docker pull dequesystems/axe-mcp-server:latest.

npx -y @deque/axe-auth run start de container en superviseert deze gedurende de sessie, waarbij een nieuw aangemaakte toegangstoken naar de draaiende server wordt gestuurd voordat de huidige verloopt. Je vernieuwingstoken verlaat nooit je machine – alleen kortlevende toegangstokens bereiken de server. De -y-vlag slaat de eerste keer dat de "Ok om door te gaan?"-prompt die npx anders zou vragen in een niet-interactieve shell, over.

De resterende vlaggen bestaan om die push binnen de container bereikbaar te maken:

  • -p 127.0.0.1:9223:9223 publiceert de vernieuwingsluisteraar van de server alleen op de host-loopback en houdt deze van de externe interfaces van je machine af.
  • -e AXE_ACCESS_TOKEN, -e AXE_TOKEN_REFRESH_PORT en -e AXE_TOKEN_REFRESH_SECRET sturen de waarden door die run genereert naar de container. Geef de namen alleen door, zonder =value — run verzorgt ze.
  • -e AXE_TOKEN_REFRESH_HOST=0.0.0.0 bindt de luisteraar aan de netwerkinterface van de container. Een gepubliceerde poort wordt daarheen doorgestuurd in plaats van naar de loopback van de container, zodat de standaard loopbackbinding onbereikbaar zou zijn. Het gedeelde geheim, niet de isolatie van de container, is wat het eindpunt beveiligt.

9223 is een voorbeeld — elke vrije poort op je machine werkt, zolang AXE_TOKEN_REFRESH_PORT en de -p publiceren dezelfde noemen. Zie Token vernieuwingsvariabelen voor de volledige referentie.

note

Gebruikt u een regionale, privécloud- of on-premises axe-instantie? 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"
}

Gebruik dezelfde URL die je doorgaf aan --server toen je inlogde, zodat de tokens die axe-auth uitgeeft afkomstig zijn van de instantie waarnaar de server oproept. Indien weggelaten, gebruikt de server standaard https://axe.deque.com (Deque's gedeelde US SaaS-instantie). Zie Configuratiereferentie voor details.

npm

De npm-distributie draait op Node.js. Gebruik een actieve Node.js LTS-release — oudere versies worden mogelijk niet ondersteund.

De npm-distributie heeft een Chromium-browser nodig — installeer er een via Playwright of verwijs naar een bestaande binaire versie. Zie Een Distributie Kiezen.

API-sleutel

Maak een .vscode/mcp.json bestand aan in je werkruimte (projectniveau) of voeg de server toe aan je gebruikersconfiguratie:

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

Je configuratie bevat een referentie in het env blok. Projectniveau-bestanden zoals .vscode/mcp.json bevinden zich in je repository — voeg ze toe aan .gitignore, of houd referenties in je gebruikersconfiguratie. Zie Geheimen Veilig Afhandelen hieronder.

OAuth 2.0

OAuth 2.0 wordt ook ondersteund met de npm-distributie. Wikkel de server in @deque/axe-auth run precies zoals hierboven — er is geen container om een poort in te publiceren, dus het commando is korter:

{
  "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 start de server en houdt toezicht zolang de sessie duurt, waarbij een nieuw aangemaakte toegangstoken naar het lopende proces wordt gestuurd voordat de huidige verloopt. Er is hier geen poortpublicatie nodig: het omhulde proces erft AXE_TOKEN_REFRESH_PORT direct en de luisteraar blijft op loopback. 9223 is een voorbeeld — elke vrije poort op je machine werkt, en de variabele is hier optioneel: laat het weg en run kiest een vrije poort voor de sessie.

caution

In tegenstelling tot een container erft de npm-distributie je volledige shell-omgeving. Als AXE_API_KEY daar wordt geëxporteerd, bereikt het de server samen met de OAuth-token en weigert de server te starten. Zet het uit in de shell waarmee je je editor start, of gebruik de bovenstaande Docker-configuratie, die alleen de variabelen ontvangt die met expliciete -e-vlaggen worden doorgegeven.

Zie Authenticatie voor de volledige flow.

note

Stel ofwel AXE_API_KEY of AXE_ACCESS_TOKEN in — niet beide. De server zal bij het opstarten falen als beide variabelen zijn ingesteld.

Geheimen Veilig Afhandelen

Als je een referentie inline plaatst in het env blok, behandel dat bestand dan als elk ander geheim:

  • Nooit in source control opnemen. Projectniveau-bestanden zoals .vscode/mcp.json bevinden zich in je repository — voeg ze toe aan je .gitignore, of houd referenties in je gebruikersconfiguratie.
  • Gebruik bij voorkeur uw OS-sleutelhanger of een geheimbeheerder waar ondersteund. Voor OAuth slaat @deque/axe-auth tokens al op in je systeem-sleutelhanger — zie Authenticatie.
  • Beperk bestandsrechten zodat alleen je gebruiker het bestand kan lezen (bijvoorbeeld, chmod 600 .vscode/mcp.json op macOS en Linux).

Start de MCP-server

  1. Open VS Code met je geconfigureerde instellingen
  2. Vind de "axe-mcp-server" invoer in je mcp.json bestand
  3. Klik op de Start knop die boven de serverconfiguratie verschijnt
  4. Als je API-sleutelauthenticatie hebt geconfigureerd, voer dan je API-sleutel in wanneer hierom wordt gevraagd. Als je OAuth hebt geconfigureerd, start de server zonder prompt en haalt een token op uit je systeem-sleutelhanger.

Prompts indienen bij Copilot

Zodra de axe MCP-server draait, kun je deze gebruiken via de chatinterface van Copilot in VS Code:

  1. Open Copilot-chat in VS Code
  2. Zorg ervoor dat je in agentmodus bent om gebruik van hulpmiddelen toe te staan
  3. Dien prompts in om websites te analyseren en toegankelijkheidsproblemen te verhelpen

Voor aanbevolen aangepaste instructies die Copilot door de analyse-dan-remediëring workflow leiden, zie Uw AI-Agent Configureren.

Is this page helpful?

Help us improve this page

Still need help?