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

O servidor Axe MCP pode ser adicionado no nível de projeto ou de usuário.

Escolher o escopo

  • 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 mcpServers objeto em ~/.claude.json no seu diretório home (aplica-se a todos os seus projetos). Você também pode gerenciar servidores a nível de usuário com o claude mcp add --scope user comando — veja o Claude Code MCP para detalhes.

Adicionando o JSON de configuração

Adicione o seguinte JSON de configuração.

info

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

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

A configuração utiliza "AXE_API_KEY": "${AXE_API_KEY}" para manejo seguro de entrada. A sintaxe de ${AXE_API_KEY} instrui o Claude Code a obter o valor do seu ambiente de shell. Para mais informações, consulte a documentação do Claude Code MCP.

note

Usando uma instância regional, nuvem privada ou axe local? Atualize o valor AXE_SERVER_URL no bloco env com a 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 padrão é https://axe.deque.com (a instância SaaS compartilhada dos EUA da Deque). Veja Opções de Configuração para detalhes.

Defina sua chave de API

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.).

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 token de acesso novo toda vez que o servidor inicia.

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

{
  "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, nuvem privada ou axe local? Adicione AXE_SERVER_URL ao comando Docker e um 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 (a instância SaaS compartilhada dos EUA da Deque). Veja Opções de Configuração para detalhes.

note

Esta configuração usa sh -c para permitir a substituição no shell. $(npx -y @deque/axe-auth token) executa na inicialização do servidor e injeta um token de acesso válido no contêiner Docker. O -y flag pula o prompt "Ok para prosseguir?" que npx normalmente perguntaria 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 usa um shell POSIX (sh) e substituição de comando ($(...)), que não está disponível em cmd.exe ou PowerShell por padrão. Execute o Claude Code a partir de um Git Bash ou shell WSL para que sh esteja no seu PATH.

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 e remediate disponíveis

Configurando o Claude Code (recomendado)

Para garantir que o Claude Code use corretamente as ferramentas do servidor Axe MCP, adicione as seguintes instruções a um arquivo CLAUDE.md no raiz do seu projeto. Isso instrui o Claude a seguir o fluxo de trabalho de analisar e depois remediar corretamente.

# Accessibility Testing and Remediation Workflow

## MANDATORY WORKFLOW - DO NOT DEVIATE

When working with accessibility issues, you MUST follow this exact workflow:

### 1. Analysis Phase

When asked to analyze pages for accessibility issues, you MUST:

- Use the `analyze` tool to scan the page
- Do NOT manually identify accessibility issues
- Always provide the complete URL being analyzed

### 2. Remediation Phase

When asked to remediate or fix accessibility issues, you MUST:

- First use `remediate` tool for EACH violation found
- Provide the exact HTML element, rule ID, and issue description
- Review the remediation guidance before making any code changes
- Apply fixes based on the remediate tool's recommendations
- Do NOT manually fix accessibility issues without first using the remediate tool

### 3. Verification Phase

After applying fixes, you MUST:

- Re-run `analyze` to verify all issues are resolved
- Confirm zero violations before considering the task complete

Para mais detalhes sobre as instruções do agente, consulte Configurando Seu Agente de IA.

Is this page helpful?

Help us improve this page

Still need help?