Configuración en VS Code con 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, elige una distribución (Docker o npm) y configura la autenticación (clave API o OAuth 2.0). Luego, añade la configuración correspondiente a continuación.

La configuración se puede usar a nivel de proyecto o a nivel de configuración de usuario (en todos los proyectos). Para la configuración a nivel de proyecto, crea un .vscode/mcp.json archivo en tu área de trabajo. Para una configuración a nivel de usuario, añade un servidor MCP a tu archivo de configuración de usuario existente. Para más información, consulta el documentación de VS Code MCP.

Docker

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

La configuración utiliza "AXE_API_KEY": "${input:axe-api-key}" para el manejo seguro de entradas. Esto te pedirá tu clave API cuando el servidor se inicie por primera vez.

note

¿Usando una instancia regional, en una nube privada o local de axe? Añade AXE_SERVER_URL al bloque env con la URL base de tu instancia:

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

Si se omite, el servidor predeterminará a https://axe.deque.com (la instancia SaaS compartida de Deque en EE.UU.). Consulta Referencia de configuración para más detalles.

OAuth 2.0

Antes de configurar, complete Paso 1: Autenticar en la guía de Autenticación.

Esto utiliza @deque/axe-auth token para obtener un nuevo token de acceso cada vez que el servidor se inicia. No se necesita un bloque inputs — el token se recupera automáticamente de la llavero de tu 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"
      ]
    }
  }
}
note

¿Utiliza una instancia de axe en una nube regional, privada o local? Añada AXE_SERVER_URL al comando de Docker y un env bloque con la URL base de su instancia:

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

Si se omite, el servidor por defecto usa https://axe.deque.com (la instancia compartida de Deque en EE. UU. SaaS). Consulte Referencia de Configuración para más detalles.

note

Esta configuración utiliza sh -c para permitir la sustitución de shell. $(npx -y @deque/axe-auth token) se ejecuta al iniciar el servidor e inyecta un token de acceso válido en el contenedor de Docker. El -y flag omite el mensaje "¿Está bien continuar?" que npx de otro modo preguntaría en una shell no interactiva. No establezca AXE_API_KEY junto con AXE_ACCESS_TOKEN.

caution

Usuarios de Windows: Esta configuración utiliza un shell POSIX (sh) y sustitución de comandos ($(...)), lo cual no está disponible en cmd.exe ni en PowerShell por defecto. Ejecute su editor desde un shell de Git Bash o WSL para que sh esté en su PATH.

npm

La distribución de npm se ejecuta en Node.js. Use una versión activa LTS de Node.js — es posible que las versiones anteriores no sean compatibles.

La distribución npm necesita un navegador Chromium: instala uno a través de Playwright o señala un binario existente. Ve Eligiendo una Distribución.

Clave API

Crea un .vscode/mcp.json archivo en tu área de trabajo (nivel de proyecto) o añade el servidor a tu configuración de usuario:

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

Tu configuración contiene una credencial en su env bloque. Archivos a nivel de proyecto como .vscode/mcp.json viven en tu repositorio — añádelos a .gitignore, o mantén las credenciales en tu configuración de usuario. Consulta Manejo seguro de secretos a continuación.

OAuth 2.0

OAuth 2.0 también es compatible con la distribución npm — configura AXE_ACCESS_TOKEN en lugar de AXE_API_KEY, inyectando un token nuevo de @deque/axe-auth token al inicio. Consulta Autenticación para el flujo completo.

note

Configure ya sea AXE_API_KEY o AXE_ACCESS_TOKEN — no ambos. El servidor fallará al iniciar si ambas variables están configuradas.

Manejo seguro de secretos

Si insertas una credencial en el env bloque, trata ese archivo como cualquier otro secreto:

  • Nunca lo lleves al control de versiones. Archivos a nivel de proyecto como .vscode/mcp.json viven en tu repositorio — añádelos a tu .gitignore, o mantén las credenciales en tu configuración de usuario.
  • Prefiere el llavero de tu sistema operativo o un gestor de secretos donde sea compatible. Para OAuth, @deque/axe-auth ya guarda tokens en tu llavero del sistema — consulta Autenticación.
  • Restringe los permisos de archivos para que solo tu usuario pueda leer el archivo (por ejemplo, chmod 600 .vscode/mcp.json en macOS y Linux).

Iniciar el Servidor MCP

  1. Abre VS Code con tus configuraciones establecidas
  2. Localiza la "axe-mcp-server" entrada en tu mcp.json archivo
  3. Haz clic en el **Inicio** botón que aparece sobre la configuración del servidor
  4. Si configuraste la autenticación de clave API, ingresa tu clave API cuando se te solicite. Si configuraste OAuth, el servidor se inicia sin un aviso y recupera un token de tu llavero del sistema.

Enviar indicaciones a Copilot

Una vez que el servidor axe MCP está en funcionamiento, puedes usarlo a través de la interfaz de chat de Copilot en VS Code:

  1. Abre el chat de Copilot en VS Code
  2. Asegúrate de estar en modo agente para permitir el uso de herramientas
  3. Envía indicaciones para analizar sitios web y remediar problemas de accesibilidad

Para instrucciones personalizadas recomendadas que guíen a Copilot a través del flujo de trabajo de analizar y luego remediar, consulta Configurando Tu Agente AI.