Configuration dans VS Code avec 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

Avant de configurer, choisissez une distribution (Docker ou npm) et configurez l'authentification (clé API ou OAuth 2.0). Ensuite, ajoutez la configuration correspondante ci-dessous.

La configuration peut être utilisée soit au niveau du projet, soit au niveau des paramètres utilisateur (pour tous les projets). Pour la configuration du projet, créez un fichier .vscode/mcp.json dans votre espace de travail. Pour une configuration au niveau des paramètres utilisateur, ajoutez un serveur MCP à votre fichier de configuration utilisateur existant. Pour plus d'informations, voir documentation MCP de VS Code.

Docker

Clé API

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

La configuration utilise "AXE_API_KEY": "${input:axe-api-key}" pour la gestion sécurisée des entrées. Cela vous demandera votre clé API lorsque le serveur démarre pour la première fois.

note

Vous utilisez une instance axe régionale, cloud privé ou sur site ? Ajoutez AXE_SERVER_URL au bloc env bloc avec l'URL de base de votre instance :

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

Si omis, le serveur passe par défaut à https://axe.deque.com (l'instance SaaS US partagée de Deque). Voir Référence de configuration pour plus de détails.

OAuth 2.0

Avant de configurer, complétez Étape 1 : Authentification dans le guide d'authentification.

Cela utilise @deque/axe-auth token pour obtenir un nouveau jeton d'accès chaque fois que le serveur démarre. Aucun inputs bloc n'est nécessaire — le jeton est récupéré automatiquement dans le trousseau de clés de votre système.

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

Utilisez-vous une instance axe régionale, privée ou sur site ? Ajoutez AXE_SERVER_URL à la commande Docker et un env bloc avec l'URL de base de votre instance :

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

Si omis, le serveur utilise par défaut https://axe.deque.com (l'instance SaaS partagée de Deque aux États-Unis). Voir Référence de configuration pour plus de détails.

note

Cette configuration utilise sh -c pour permettre la substitution de shell. $(npx -y @deque/axe-auth token) s'exécute au démarrage du serveur et injecte un jeton d'accès valide dans le conteneur Docker. Le -y drapeau saute l'invite "D'accord pour continuer ?" du premier démarrage que npx demanderait autrement dans un shell non interactif. Ne pas définir AXE_API_KEY avec AXE_ACCESS_TOKEN.

caution

Utilisateurs de Windows : Cette configuration utilise un shell POSIX (sh) et la substitution de commandes ($(...)), qui ne sont pas disponibles dans cmd.exe ou PowerShell par défaut. Lancez votre éditeur depuis un shell Git Bash ou WSL afin que sh soit sur votre PATH.

npm

La distribution npm fonctionne avec Node.js. Utilisez une version LTS active de Node.js — les versions plus anciennes peuvent ne pas être prises en charge.

La distribution npm nécessite un navigateur Chromium — installez-en un via Playwright ou pointez vers un binaire existant. Voir Choisir une distribution.

Clé API

Créez un fichier .vscode/mcp.json dans votre espace de travail (au niveau du projet) ou ajoutez le serveur à votre configuration utilisateur :

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

Votre configuration contient une information d'identification dans son bloc env . Les fichiers au niveau du projet comme .vscode/mcp.json se trouvent dans votre dépôt — ajoutez-les à .gitignore, ou gardez les informations d'identification dans votre configuration utilisateur à la place. Voir Gérer les secrets en toute sécurité ci-dessous.

OAuth 2.0

OAuth 2.0 est également pris en charge avec la distribution npm — configurez AXE_ACCESS_TOKEN au lieu de AXE_API_KEY, en injectant un nouveau jeton depuis @deque/axe-auth token au démarrage. Voir Authentification pour le flux complet.

note

Définissez soit AXE_API_KEY ou AXE_ACCESS_TOKEN — pas les deux. Le serveur échouera au démarrage si les deux variables sont définies.

Gérer les secrets en toute sécurité

Si vous intégrez une information d'identification dans le bloc env , traitez ce fichier comme n'importe quel autre secret :

  • Ne jamais le commettre dans le contrôle de version. Les fichiers au niveau du projet comme .vscode/mcp.json se trouvent dans votre dépôt — ajoutez-les à votre .gitignore, ou gardez les informations d'identification dans votre configuration utilisateur à la place.
  • Privilégiez votre trousseau de clés OS ou un gestionnaire de secrets lorsque c'est pris en charge. Pour OAuth, @deque/axe-auth stocke déjà les jetons dans le trousseau de clés de votre système — voir Authentification.
  • Restreindre les permissions de fichier pour que seul votre utilisateur puisse lire le fichier (par exemple, chmod 600 .vscode/mcp.json sur macOS et Linux).

Démarrer le serveur MCP

  1. Ouvrez VS Code avec vos paramètres configurés
  2. Localisez l' "axe-mcp-server" entrée dans votre mcp.json fichier
  3. Cliquez sur le bouton **Démarrer** qui apparaît au-dessus de la configuration du serveur
  4. Si vous avez configuré l'authentification par clé API, entrez votre clé API lorsque vous y êtes invité. Si vous avez configuré OAuth, le serveur démarre sans invite et récupère un jeton depuis votre trousseau système.

Soumettre des invites à Copilot

Une fois que le serveur axe MCP est en marche, vous pouvez l'utiliser via l'interface de chat Copilot de VS Code :

  1. Ouvrez le chat Copilot dans VS Code
  2. Assurez-vous d'être en mode agent pour permettre l'utilisation des outils
  3. Soumettez des invites pour analyser des sites web et résoudre les problèmes d'accessibilité

Pour des instructions personnalisées recommandées qui guident Copilot à travers le flux analyser-puis-remédier, voir Configurer votre agent d'IA.

Is this page helpful?

Help us improve this page

Still need help?