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

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.

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 utiliza por padrão https://axe.deque.com (a instância SaaS compartilhada dos EUA pela Deque). Veja Referência de Configuração para mais detalhes.

OAuth 2.0

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

Inicie o servidor através de @deque/axe-auth run, o que mantém o token de acesso do servidor em execução atualizado enquanto a sessão durar. Nenhum bloco de inputs é necessário — as credenciais são recuperadas automaticamente do seu gerenciador de chaves do sistema.

{
  "servers": {
    "axe-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@deque/axe-auth",
        "run",
        "--",
        "docker",
        "run",
        "--add-host=host.docker.internal:host-gateway",
        "-i",
        "--rm",
        "-p",
        "127.0.0.1:9223:9223",
        "-e",
        "AXE_ACCESS_TOKEN",
        "-e",
        "AXE_TOKEN_REFRESH_PORT",
        "-e",
        "AXE_TOKEN_REFRESH_SECRET",
        "-e",
        "AXE_TOKEN_REFRESH_HOST=0.0.0.0",
        "dequesystems/axe-mcp-server:latest"
      ],
      "env": {
        "AXE_TOKEN_REFRESH_PORT": "9223"
      }
    }
  }
}
note

A atualização do token chegou ao servidor axe MCP em v1.5.0. npx -y @deque/axe-auth sempre busca o CLI atual, mas uma imagem Docker puxada antes dessa versão não tem um ouvinte de atualização para run enviar — obtenha-a novamente com docker pull dequesystems/axe-mcp-server:latest.

npx -y @deque/axe-auth run inicia o contêiner e o supervisiona durante a sessão, enviando um token de acesso recém-gerado para o servidor em execução antes que o atual expire. Seu token de atualização nunca sai da sua máquina — apenas tokens de acesso de curta duração chegam ao servidor. A flag -y pula o prompt "Ok para prosseguir?" que npx normalmente perguntaria em um shell não interativo.

As flags restantes existem para tornar essa transmissão acessível dentro do contêiner:

  • -p 127.0.0.1:9223:9223 publica o ouvinte de atualização do servidor apenas no host loopback, mantendo-o fora das interfaces externas da sua máquina.
  • -e AXE_ACCESS_TOKEN, -e AXE_TOKEN_REFRESH_PORT e -e AXE_TOKEN_REFRESH_SECRET encaminham os valores que run gera para dentro do contêiner. Passe apenas os nomes, sem =value — run os fornece.
  • -e AXE_TOKEN_REFRESH_HOST=0.0.0.0 vincula o ouvinte à interface de rede do contêiner. Uma porta publicada reencaminha para lá em vez de para o loopback do contêiner, então o vínculo padrão ao loopback ficaria inacessível. O segredo compartilhado, e não o isolamento do contêiner, é o que protege o endpoint.

9223 é um exemplo — qualquer porta livre na sua máquina funciona, desde que AXE_TOKEN_REFRESH_PORT e o -p publicado nomeiem a mesma. Veja Variáveis de atualização de token para a referência completa.

note

Usando uma instância regional, privada, em nuvem ou local do axe? Adicione AXE_SERVER_URL ao comando Docker e ao bloco env, junto com a porta de atualização:

"args": [
  "-y",
  "@deque/axe-auth",
  "run",
  "--",
  "docker",
  "run",
  "--add-host=host.docker.internal:host-gateway",
  "-i",
  "--rm",
  "-p",
  "127.0.0.1:9223:9223",
  "-e",
  "AXE_SERVER_URL",
  "-e",
  "AXE_ACCESS_TOKEN",
  "-e",
  "AXE_TOKEN_REFRESH_PORT",
  "-e",
  "AXE_TOKEN_REFRESH_SECRET",
  "-e",
  "AXE_TOKEN_REFRESH_HOST=0.0.0.0",
  "dequesystems/axe-mcp-server:latest"
],
"env": {
  "AXE_TOKEN_REFRESH_PORT": "9223",
  "AXE_SERVER_URL": "https://your-axe-instance.example.com"
}

Use o mesmo URL que você passou para --server ao fazer login, assim os tokens que axe-auth emite vêm da instância que o servidor chama. Se omitido, o servidor usa por padrão https://axe.deque.com (a instância SaaS compartilhada dos EUA da Deque). Veja Referência de Configuração para mais detalhes.

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

Sua configuração contém uma credencial em seu bloco env. Arquivos a nível de projeto como .vscode/mcp.json residem no seu repositório — adicione-os a .gitignore, ou mantenha credenciais na sua configuração de usuário. Veja Tratando segredos com segurança abaixo.

OAuth 2.0

OAuth 2.0 é compatível com a distribuição npm também. Envolva o servidor em @deque/axe-auth run exatamente como acima — não há um contêiner para publicar uma porta, então o comando é mais curto:

{
  "servers": {
    "axe-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@deque/axe-auth",
        "run",
        "--",
        "npx",
        "-y",
        "axe-mcp-server"
      ],
      "env": {
        "AXE_TOKEN_REFRESH_PORT": "9223"
      }
    }
  }
}

npx -y @deque/axe-auth run inicia o servidor e o supervisiona durante toda a sessão, enviando um token de acesso recém-gerado para o processo em execução antes que o atual expire. Não é necessário publicar a porta aqui: o processo encapsulado herda AXE_TOKEN_REFRESH_PORT diretamente e o ouvinte permanece no loopback. 9223 é um exemplo — qualquer porta livre em sua máquina funciona, e a variável é opcional aqui: omita-a e run escolhe uma porta livre para a sessão.

caution

Diferente de um contêiner, a distribuição npm herda todo o ambiente do seu shell. Se AXE_API_KEY for exportado lá, ele chega ao servidor junto com o token OAuth e o servidor se recusa a iniciar. Desfaça essa configuração no shell do qual você inicia seu editor, ou use a configuração Docker acima, que apenas recebe as variáveis passadas com flags explícitas -e.

Veja Autenticação para o fluxo completo.

note

Defina ou AXE_API_KEY ou AXE_ACCESS_TOKEN — não ambos. O servidor falhará ao iniciar se ambas as variáveis estiverem definidas.

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.

Is this page helpful?

Help us improve this page

Still need help?