Référence de configuration
Cette page documente les variables d'environnement que le serveur axe MCP lit, ainsi que les instructions personnalisées recommandées pour votre agent AI. Celles-ci s'appliquent à la fois aux distributions Docker et npm. Pour savoir où placer ces valeurs, consultez votre guide de configuration client.
Options de configuration
Le serveur axe MCP prend en charge plusieurs variables d'environnement pour la personnalisation :
| Var env | Description | Défaut |
|---|---|---|
AXE_API_KEY |
Clé API pour l'authentification (voir Clé API). Mutuellement exclusif avec AXE_ACCESS_TOKEN. |
|
AXE_ACCESS_TOKEN |
Jeton OAuth 2.0 Bearer pour l'authentification (voir OAuth 2.0). Mutuellement exclusif avec AXE_API_KEY. |
|
AXE_SERVER_URL |
L'URL de base du portail de compte axe de votre organisation. Nécessaire uniquement si votre organisation n'utilise pas l'instance SaaS partagée aux États-Unis par défaut. Voir ci-dessous pour plus de détails. | "https://axe.deque.com" |
AXE_CHROME_PATH |
Chemin vers un binaire Chrome/Chromium à utiliser à la place de l'installation gérée par Playwright. Distribution npm uniquement. Voir ci-dessous pour les exigences. | |
BROWSER_TIMEOUT_MS |
Le nombre de millisecondes que nous autorisons pour que les interactions avec le navigateur attendent avant un délai d'expiration | 30000 |
LOG_LEVEL |
Suit le Protocole Syslog; les valeurs prises en charge sont "debug", "info", "warn", et "error" |
"info" |
AXE_SERVER_URL
La valeur par défaut (https://axe.deque.com) est correcte pour la plupart des utilisateurs — ceux utilisant l'instance SaaS partagée aux États-Unis par Deque. Si votre organisation utilise l'un des éléments suivants, vous devez définir AXE_SERVER_URL à l'URL de base de votre instance :
- Une instance SaaS régionale (EU, Australie, Francfort, etc.)
- Un cloud privé déploiement
- Une installation sur site installation
Si vous ne savez pas quelle instance votre organisation utilise, vérifiez l'URL que vous utilisez pour vous connecter au portail de compte axe, ou demandez à votre administrateur.
Définir AXE_SERVER_URL explicitement dans le env bloc de configuration de votre serveur MCP. Les guides d'installation client incluent des exemples montrant exactement où l'ajouter.
AXE_CHROME_PATH
distribution npm uniquement. Cela n'est pas pris en charge dans Docker, qui utilise toujours son navigateur intégré — le serveur échoue à démarrer si AXE_CHROME_PATH est défini sous la distribution Docker.
Par défaut, la distribution npm utilise la version de Chromium que vous installez via Playwright. Définissez AXE_CHROME_PATH sur le chemin complet d'un fichier binaire Chrome/Chromium existant pour l'utiliser à la place et éviter l'installation de Playwright.
- La valeur doit être un fichier binaire exécutable, et non un
.appensemble ou un répertoire. Sur macOS, par exemple, pointez vers le binaire à l'intérieur de l'ensemble :/Applications/Google Chrome for Testing.app/Contents/MacOS/Google Chrome for Testing. - Le binaire doit se lancer et répondre à
--version. Le serveur valide cela au démarrage et échoue rapidement avecUnable to find specified chrome instances'il ne peut pas. - Google Chrome stable 137 et ultérieur n'est pas pris en charge. Utilisez Chrome pour les tests ou un autre binaire compatible avec Chromium.
Les analyze et igt outils acceptent également un chromePath argument pour chaque appel, qui a la priorité sur AXE_CHROME_PATH pour cet appel.
Configurer votre agent IA (Recommandé)
Pour garantir que votre agent de codage IA utilise correctement les outils de serveur MCP d'axe et respecte les meilleures pratiques en matière d'accessibilité, vous pouvez lui fournir des instructions personnalisées. Ces instructions aident l'agent à comprendre le flux de travail approprié pour analyser et rectifier les problèmes d'accessibilité.
Où ajouter des instructions
La méthode varie selon le client :
- VS Code avec GitHub Copilot - Ajoutez à
.github/copilot-instructions.mdà la racine de votre projet - Cursor - Ajoutez aux " Règles de Cursor " dans les paramètres
- Claude Code - Ajoutez à un
CLAUDE.mdfichier à la racine de votre projet - Claude Desktop - Ajoutez aux instructions personnalisées dans les paramètres
- Autres clients MCP - Consultez la documentation de votre client pour la configuration des instructions personnalisées
Exemple d'instructions de flux de travail
Ci-dessous un modèle recommandé que vous pouvez adapter pour votre agent :
# Accessibility Testing and Remediation Workflow
## MANDATORY WORKFLOW - DO NOT DEVIATE
When working with accessibility issues, you MUST follow this exact workflow:
### 1. Analysis Phase
When asked to analyze pages for accessibility issues, you MUST:
- Use the `analyze` tool to scan the page
- Do NOT manually identify accessibility issues
- Always provide the complete URL being analyzed
### 2. Authentication & Pre-Scan Setup
When the user's request involves credentials, form input, dismissing
overlays, or waiting for content before the scan, you MUST:
- Pass an ordered `before` array to the `analyze` tool using the
`click`, `fill`, and `waitFor` actions
- Resolve any references to env vars, `.env*` files, or local
configuration into literal strings BEFORE calling the tool — the
server treats `value` as a literal and will not expand `${VAR}`,
`$VAR`, or `{{VAR}}` syntax
- Use `fill` for secret values so the server's redaction protections
apply; never embed secrets in a `selector`, which appears in logs
and error messages
- ASK the user when the source of a credential or value is ambiguous;
do NOT guess or fabricate values
- Use ONLY selectors the user provided; if a step needs a selector
the user did not name, ASK rather than guess
- Use `waitFor` after any `click`/`fill` that triggers async UI
(route changes, late-rendered content) to deterministically gate
the next step or the scan — pick a selector that exists ONLY in
the post-interaction state (e.g., a logout button or dashboard
heading), never a generic one like `body` or `#app` that already
exists beforehand
### 3. Remediation Phase
When asked to remediate or fix accessibility issues, you MUST:
- Collect ALL violations from the analysis and pass them to the
`remediate` tool in a SINGLE batched call — do NOT call `remediate`
once per issue
- Give each issue a unique `id` so each result can be correlated
back to its input
- Provide the exact HTML element, rule ID, and issue description for
every issue in the batch
- Review the remediation guidance before making any code changes
- Apply fixes based on the remediate tool's recommendations
- Do NOT manually fix accessibility issues without first using the remediate tool
### 4. Verification Phase
After applying fixes, you MUST:
- Re-run `analyze` to verify all issues are resolved
- Confirm zero violations before considering the task complete
## Required Workflow Example:
1. analyze → Find violations
2. remediate → Pass ALL violations in one batched call to get fix guidance
3. Apply recommended fixes to code
4. analyze → Verify fixes
## Enforcement
- NEVER skip the remediate tool when fixing accessibility issues
- ALWAYS use both analyze and remediate tools as specified
- This workflow ensures proper accessibility best practices and compliancePourquoi c'est important
Ces instructions garantissent que votre agent :
- Utilise l'expertise de Deque - Tire parti des modèles d'IA entraînés sur des décennies de données d'évaluation de l'accessibilité au lieu des connaissances générales des LLM
- Suit les meilleures pratiques - Applique des corrections cohérentes et conformes à la WCAG plutôt que des solutions génériques
- Vérifie les changements - Confirme toujours que les corrections ont effectivement résolu les problèmes
- Évite une confiance excessive - Ne présume pas savoir comment résoudre les problèmes d'accessibilité sans l'avis d'un expert
Bien que facultatives, ces instructions améliorent significativement la qualité et la fiabilité des corrections d'accessibilité dans votre base de code.
