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 agrega la configuración correspondiente a continuación.

La configuración se puede usar en el nivel de proyecto o en el nivel de configuración del usuario (en todos los proyectos). Para la configuración a nivel de proyecto, crea un archivo .vscode/mcp.json en tu espacio de trabajo. Para una configuración a nivel de usuario, agrega un servidor MCP a tu archivo de configuración del 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 solicitará 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 predetermina 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 usa @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 tu llavero del 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? Agregue AXE_SERVER_URL al comando de Docker y un bloque de env 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 usa por defecto https://axe.deque.com (la instancia compartida de SaaS de Deque en EE.UU.). Consulte Referencia de Configuración para más detalles.

note

Esta configuración usa 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 Docker. El indicador -y omite el mensaje de "¿Está bien continuar?" que npx preguntaría de otro modo en una shell no interactiva. No configure 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 o 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 un versión activa LTS de Node.js — es posible que las versiones anteriores no sean compatibles.

La distribución npm necesita un navegador Chromium: puedes instalar uno a través de Playwright o apuntar a un binario existente. Consulta Eligiendo una Distribución.

Clave API

Crea un archivo .vscode/mcp.json en tu espacio de trabajo (a nivel de proyecto) o agrega 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 bloque env. Los archivos a nivel de proyecto como .vscode/mcp.json residen en tu repositorio: agrégales 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 de npm: configura AXE_ACCESS_TOKEN en lugar de AXE_API_KEY, inyectando un nuevo token de @deque/axe-auth token al inicio. Consulta Autenticación para conocer el flujo completo.

note

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

Manejo seguro de secretos

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

  • Nunca lo lleves al control de versiones. Los archivos a nivel de proyecto como .vscode/mcp.json residen en tu repositorio: agrégales 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 almacena los 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 entrada "axe-mcp-server" en tu archivo mcp.json
  3. Haz clic en el botón **Inicio** que aparece arriba de 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ían a Copilot a través del flujo de trabajo analizar-luego-remediar, consulta Configurando Tu Agente AI.

Is this page helpful?

Help us improve this page

Still need help?