Setup in VS Code met Copilot
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.
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.
Dit gebruikt @deque/axe-auth token om een nieuwe toegangstoken te verkrijgen telkens wanneer de server start. Er is geen inputs blok nodig — de token wordt automatisch opgehaald uit je systeem-sleutelhanger.
{
"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"
]
}
}
}Gebruikt u een regionale, privécloud- of on-premises axe-instantie? Voeg AXE_SERVER_URL toe aan het Docker-commando en een env-blok met de basis-URL van je instantie:
"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"
}Als het wordt weggelaten, gebruikt de server standaard https://axe.deque.com (Deque's gedeelde US SaaS-instantie). Zie Configuratiereferentie voor details.
Deze configuratie gebruikt sh -c om shell-substitutie toe te staan. $(npx -y @deque/axe-auth token) draait bij het opstarten van de server en injecteert een geldig toegangstoken in de Docker-container. De -y-vlag slaat de "Ok om door te gaan?"-prompt die npx anders zou vragen in een niet-interactieve shell over. Stel AXE_API_KEY niet in samen met AXE_ACCESS_TOKEN.
Windows-gebruikers: Deze configuratie maakt gebruik van een POSIX-shell (sh) en commando-substitutie ($(...)), wat standaard niet beschikbaar is in cmd.exe of PowerShell. Voer je editor uit vanuit een Git Bash- of WSL-shell zodat sh op je PATH staat.
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"
}
}
}
}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 — stel AXE_ACCESS_TOKEN in in plaats van AXE_API_KEY, en injecteer een nieuwe token uit @deque/axe-auth token bij opstarten. Zie Authenticatie voor de volledige flow.
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.jsonbevinden 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-authtokens al op in je systeem-sleutelhanger — zie Authenticatie. - Beperk bestandsrechten zodat alleen je gebruiker het bestand kan lezen (bijvoorbeeld,
chmod 600 .vscode/mcp.jsonop macOS en Linux).
Start de MCP-server
- Open VS Code met je geconfigureerde instellingen
- Vind de
"axe-mcp-server"invoer in jemcp.jsonbestand - Klik op de Start knop die boven de serverconfiguratie verschijnt
- 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:
- Open Copilot-chat in VS Code
- Zorg ervoor dat je in agentmodus bent om gebruik van hulpmiddelen toe te staan
- 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.