Configuração no VS Code com 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

A configuração a seguir pode ser usada em nível de projeto ou em nível de configurações do usuário (em todos os projetos). Para configuração em nível de projeto, crie um .vscode/mcp.json arquivo em seu espaço de trabalho. Para uma configuração em nível de usuário, adicione um servidor MCP ao seu arquivo de configuração de usuário existente.

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

**Nota**: A configuração usa "AXE_API_KEY": "${input:axe-api-key}" para tratamento seguro de entrada. Isso solicitará sua chave de API quando o servidor iniciar pela primeira vez. Para mais informações sobre a configuração do VS Code MCP, consulte a documentação do VS Code MCP.

note

**Usando uma instância regional, nuvem privada ou local do axe?** Adicione AXE_SERVER_URL ao bloco env com a URL base da sua instância:

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

Se omitido, o servidor padrão é https://axe.deque.com (instância compartilhada de SaaS dos EUA da Deque). Veja Opções de Configuração para detalhes.

info

Para uma lista completa de opções configuráveis, consulte a seção Opções de Configuração .

Usando autenticação OAuth 2.0

Se preferir OAuth em vez de uma chave de API, substitua a configuração acima pela seguinte. Isso usa @deque/axe-auth token para obter um novo token de acesso cada vez que o servidor é iniciado. Nenhum inputs bloco é necessário — o token é recuperado automaticamente do chaveiro do sistema.

Antes de configurar, complete o Passo 1: Autenticação no guia de Autenticação OAuth 2.0.

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

**Usando uma instância regional, nuvem privada ou local do axe?** Adicione AXE_SERVER_URL ao comando Docker e uma env com a URL base da sua instância:

"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 omitido, o servidor padrão é https://axe.deque.com (instância compartilhada de SaaS dos EUA da Deque). Veja Opções de Configuração para detalhes.

note

Esta configuração usa sh -c para permitir a substituição de shell. $(npx -y @deque/axe-auth token) é executado na inicialização do servidor e injeta um token de acesso válido no contêiner Docker. O -y sinalizador ignora o prompt "Ok para continuar?" que npx caso contrário, perguntaria em um shell não interativo. Não configure AXE_API_KEY junto com AXE_ACCESS_TOKEN.

caution

Usuários do Windows: Esta configuração usa um shell POSIX (sh) e a substituição de comando ($(...)), que não está disponível no cmd.exe ou PowerShell por padrão. Execute o VS Code a partir de um shell Git Bash ou WSL para que sh esteja no seu PATH.

Iniciar o Servidor MCP

  1. Abra o VS Code com suas configurações configuradas
  2. Localize a entrada "axe-mcp-server" em seu mcp.json arquivo
  3. Clique no botão **Iniciar** que aparece acima da configuração do servidor
  4. Se você configurou a autenticação por chave de API, insira sua chave de API quando solicitado. Se você configurou OAuth, o servidor inicia sem um prompt e recupera um token do chaveiro do sistema.

Enviar Comandos para o Copilot

Uma vez que o axe MCP Server esteja em funcionamento, você pode usá-lo através da interface de chat do Copilot no VS Code:

  1. Abra o chat do Copilot no VS Code
  2. Certifique-se de estar no modo agente para permitir o uso das ferramentas
  3. Envie comandos para analisar sites e remediar problemas de acessibilidade

Is this page helpful?

Help us improve this page

Still need help?