Configurazione in VS Code con 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

Prima di configurare, scegli una distribuzione (Docker o npm) e configura l'autenticazione (chiave API o OAuth 2.0). Quindi aggiungi la configurazione corrispondente qui sotto.

La configurazione può essere utilizzata sia a livello di progetto che a livello di impostazioni utente (per tutti i progetti). Per la configurazione a livello di progetto, crea un file .vscode/mcp.json nel tuo spazio di lavoro. Per una configurazione a livello di impostazioni utente, aggiungi un server MCP al tuo file di configurazione utente esistente. Per maggiori informazioni, vedi il documentazione VS Code MCP.

Docker

API key

{
  "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 configurazione utilizza "AXE_API_KEY": "${input:axe-api-key}" per la gestione sicura degli input. Ti verrà richiesto di inserire la tua chiave API quando il server si avvia per la prima volta.

note

Utilizzi un'istanza axe regionale, cloud privata o on-premises? Aggiungi AXE_SERVER_URL al blocco env con l'URL di base della tua istanza:

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

Se omesso, il server usa di default https://axe.deque.com (l'istanza SaaS condivisa per gli Stati Uniti di Deque). Vedi Riferimento di configurazione per i dettagli.

OAuth 2.0

Prima di configurare, completa Passo 1: Autenticazione nella guida all'autenticazione.

Questo utilizza @deque/axe-auth token per ottenere un nuovo token di accesso ogni volta che il server si avvia. Non è necessario un blocco inputs — il token viene recuperato automaticamente dal portachiavi di sistema.

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

Utilizzi un'istanza axe regionale, privata o locale? Aggiungi AXE_SERVER_URL al comando Docker e un blocco env con l'URL di base della tua istanza:

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

Se omesso, il server predefinito è https://axe.deque.com (l'istanza condivisa SaaS statunitense di Deque). Vedi Riferimento alla configurazione per i dettagli.

note

Questa configurazione utilizza sh -c per consentire la sostituzione della shell. $(npx -y @deque/axe-auth token) viene eseguito all'avvio del server e inietta un token di accesso valido nel contenitore Docker. Il flag -y salta il prompt "Va bene procedere?" che altrimenti npx chiederebbe in una shell non interattiva. Non impostare AXE_API_KEY insieme a AXE_ACCESS_TOKEN.

caution

Utenti Windows: Questa configurazione utilizza una shell POSIX (sh) e la sostituzione di comandi ($(...)), che non è disponibile in cmd.exe o PowerShell per impostazione predefinita. Esegui il tuo editor da una shell Git Bash o WSL in modo che sh sia sul tuo PATH.

npm

La distribuzione npm funziona su Node.js. Usa un release LTS attiva di Node.js — le versioni precedenti potrebbero non essere supportate.

La distribuzione npm necessita di un browser Chromium — installane uno tramite Playwright o punta a un binario esistente. Vedi Scegliere una distribuzione.

API key

Crea un file .vscode/mcp.json nel tuo spazio di lavoro (a livello di progetto) o aggiungi il server alla tua configurazione utente:

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

La tua configurazione contiene una credenziale nel suo blocco env. I file a livello di progetto come .vscode/mcp.json si trovano nel tuo repository — aggiungili a .gitignore, oppure conserva le credenziali nella tua configurazione utente. Vedi Gestione sicura dei segreti sotto.

OAuth 2.0

OAuth 2.0 è supportato anche con la distribuzione npm — imposta AXE_ACCESS_TOKEN invece di AXE_API_KEY, iniettando un nuovo token da @deque/axe-auth token all'avvio. Vedi Autenticazione per il flusso completo.

note

Imposta o AXE_API_KEY o AXE_ACCESS_TOKEN — non entrambi. Il server fallirà all'avvio se entrambe le variabili sono impostate.

Gestione sicura dei segreti

Se includi una credenziale nel blocco env, tratta quel file come qualsiasi altro segreto:

  • Non commetterlo mai nel controllo del codice sorgente. I file a livello di progetto come .vscode/mcp.json si trovano nel tuo repository — aggiungili al tuo .gitignore, oppure conserva le credenziali nella tua configurazione utente.
  • Preferisci il portachiavi del tuo sistema operativo o un gestore di segreti dove supportato. Per OAuth, @deque/axe-auth già memorizza i token nel portachiavi di sistema — vedi Autenticazione.
  • Limita i permessi del file affinché solo il tuo utente possa leggere il file (ad esempio, chmod 600 .vscode/mcp.json su macOS e Linux).

Avvia il server MCP

  1. Apri VS Code con le tue impostazioni configurate
  2. Individua la voce "axe-mcp-server" nel tuo file mcp.json
  3. Clicca sul pulsante **Avvia** che appare sopra la configurazione del server
  4. Se hai configurato l'autenticazione tramite chiave API, inserisci la tua chiave API quando richiesto. Se hai configurato OAuth, il server si avvia senza richieste e recupera un token dal tuo portachiavi di sistema.

Invia Comandi a Copilot

Una volta che il server axe MCP è in esecuzione, puoi usarlo tramite l'interfaccia di chat di Copilot in VS Code:

  1. Apri la chat di Copilot in VS Code
  2. Assicurati di essere in modalità agente per consentire l'uso degli strumenti
  3. Invia comandi per analizzare i siti web e risolvere problemi di accessibilità

Per le istruzioni personalizzate raccomandate che guidano Copilot attraverso il flusso di lavoro di analisi e rimedio, vedi Configurare il tuo agente AI.