Configuração no VS Code com Copilot

Antes de configurar, escolha uma distribuição (Docker ou npm) e configure a autenticação (chave da API ou OAuth 2.0). Depois, adicione a configuração correspondente abaixo.

A configuração pode ser usada tanto a nível de projeto quanto a nível de configurações de usuário (em todos os projetos). Para configuração a nível de projeto, crie um arquivo .vscode/mcp.json no seu espaço de trabalho. Para configuração a nível de configurações de usuário, adicione um servidor MCP ao seu arquivo de configuração de usuário existente. Para mais informações, consulte o documentação do VS Code MCP.

Docker

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

A configuração utiliza "AXE_API_KEY": "${input:axe-api-key}" para manuseio seguro de entrada. Isto irá solicitar sua chave da API quando o servidor iniciar pela primeira vez.

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

OAuth 2.0

Antes de configurar, complete Etapa 1: Autenticar no guia de Autenticação.

Isto utiliza @deque/axe-auth token para obter um novo token de acesso cada vez que o servidor inicia. Nenhum bloco inputs é necessário — o token é recuperado automaticamente do chaveiro do 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"
      ]
    }
  }
}

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

npm

A distribuição npm é executada no Node.js. Use uma versão LTS ativa do Node.js — versões mais antigas podem não ser suportadas.

A distribuição npm precisa de um navegador Chromium — instale um via Playwright ou aponte para um binário existente. Veja Escolhendo uma Distribuição.

Chave de API

Crie um arquivo .vscode/mcp.json no seu espaço de trabalho (nível de projeto) ou adicione o servidor à sua configuração de usuário:

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

OAuth 2.0

OAuth 2.0 também é suportado com a distribuição npm — configure AXE_ACCESS_TOKEN em vez de AXE_API_KEY, injetando um token novo de @deque/axe-auth token na inicialização. Veja Autenticação para o fluxo completo.

Tratando segredos com segurança

Se você incluir uma credencial no bloco env, trate esse arquivo como qualquer outro segredo:

• Nunca o faça commit no controle de versão. Arquivos a nível de projeto como .vscode/mcp.json residem no seu repositório — adicione-os ao seu .gitignore, ou mantenha credenciais na sua configuração de usuário.
• Prefira o armazenamento de chaves do seu sistema operacional ou um gerenciador de segredos onde for suportado. Para OAuth, @deque/axe-auth já armazena tokens no chaveiro do sistema — veja Autenticação.
• Restrinja as permissões de arquivos para que somente o seu usuário possa ler o arquivo (por exemplo, chmod 600 .vscode/mcp.json no macOS e Linux).

Iniciar o Servidor MCP

1. Abra o VS Code com suas configurações configuradas
2. Localize a entrada "axe-mcp-server" no seu arquivo mcp.json
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

Para instruções personalizadas recomendadas que orientam o Copilot através do fluxo de análise e correção, veja Configurando Seu Agente de IA.