Configuração no Claude Code

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 API ou OAuth 2.0). Em seguida, adicione a configuração correspondente abaixo.

O servidor Axe MCP pode ser adicionado tanto no nível do projeto quanto no nível do usuário:

  • Nível de projeto: Crie um arquivo em .mcp.json no diretório raiz do seu projeto (melhor para compartilhar configurações com uma equipe)
  • Nível de usuário: Adicione o servidor ao objeto mcpServers em ~/.claude.json no seu diretório pessoal (aplica-se a todos os seus projetos). Você também pode gerenciar servidores a nível de usuário com o comando claude mcp add --scope user — veja Claude Code MCP para mais detalhes.
info

Se você já tiver outros servidores definidos, adicione o bloco axe-mcp-server dentro do objeto mcpServers existente.

Docker

Chave de API

{
  "mcpServers": {
    "axe-mcp-server": {
      "type": "stdio",
      "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_SERVER_URL": "https://axe.deque.com",
        "AXE_API_KEY": "${AXE_API_KEY}"
      }
    }
  }
}

A configuração usa "AXE_API_KEY": "${AXE_API_KEY}" para manipulação segura de entrada. A sintaxe ${AXE_API_KEY} instrui o Claude Code a puxar o valor do seu ambiente shell. Para mais informações, veja Claude Code MCP.

Defina sua chave de API como uma variável de ambiente no seu shell:

export AXE_API_KEY="your-api-key-here"

Para configuração permanente, adicione esta linha ao seu perfil de shell (~/.bashrc, ~/.zshrc, etc.).

note

Usando uma instância regional, nuvem privada ou axe local? Atualize o valor AXE_SERVER_URL no bloco env com o URL base da sua instância:

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

Se omitido, o servidor assume como padrão https://axe.deque.com (instância SaaS compartilhada dos EUA da 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.

Isso usa @deque/axe-auth token para obter um novo token de acesso cada vez que o servidor inicia.

{
  "mcpServers": {
    "axe-mcp-server": {
      "type": "stdio",
      "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, privada, em nuvem ou local do axe? Adicione AXE_SERVER_URL ao comando Docker e um bloco de 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 usará https://axe.deque.com como padrão (instância SaaS compartilhada dos EUA da Deque). Veja Referência de Configuração para mais 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. A flag -y pula a mensagem "Ok para continuar?" que npx pediria de outra forma em um shell não interativo. Não configure AXE_API_KEY junto com AXE_ACCESS_TOKEN.

caution

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

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 necessita de um navegador Chromium — instale um via Playwright ou aponte para um binário existente. Veja Escolhendo uma Distribuição.

Chave de API

{
  "mcpServers": {
    "axe-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "axe-mcp-server"],
      "env": {
        "AXE_API_KEY": "${AXE_API_KEY}"
      }
    }
  }
}

Configure AXE_API_KEY no seu shell conforme mostrado acima para que o Claude Code possa puxá-lo do ambiente.

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 novo token de @deque/axe-auth token na inicialização. 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.

Uso e verificação

Uma vez configurado, reinicie o Claude Code para carregar o servidor MCP.

  1. Inicie o Claude Code a partir do seu terminal: claude
  2. Digite /mcp para gerenciar conexões do servidor MCP
  3. Você deve ver axe-mcp-server listado com as ferramentas analyze, remediate e igt disponíveis

Configurando o Claude Code (recomendado)

Para garantir que o Claude Code use corretamente as ferramentas do servidor MCP da axe, adicione as instruções recomendadas de fluxo de trabalho de análise e remediação a um arquivo CLAUDE.md no raiz do seu projeto. Veja Configurando Seu Agente de IA para o modelo completo.

Is this page helpful?

Help us improve this page

Still need help?