AGENTS.md proporcionan a Codex un contexto persistente sobre tus estándares de documentación, componentes y guía de estilo.
Empezar
- Una cuenta de OpenAI con acceso a Codex
- Instala la CLI de Codex:
-
¿Todavía no tienes un sitio? Pide a tu agente que lo configure. Ejecuta
codexy pídele que complete el siguiente flujo de trabajo. Después, continúa con el siguiente paso.Flujo de trabajo de configuración del agente
Si el usuario te pide configurar Mintlify, un sitio de documentación o un proyecto local de Mintlify, completa tú mismo el siguiente flujo de trabajo. Pide al usuario únicamente la información o las aprobaciones que no puedas proporcionar. No dirijas al usuario al inicio rápido basado en el navegador, a menos que no puedas ejecutar comandos de terminal.-
Ejecuta
node --versiony confirma que indica Node.js v20.17.0 o posterior. Se prefiere una versión LTS. -
Ejecuta
mint --version. Si el comando no está disponible, instala la CLI connpm i -g mintopnpm add -g mint. Si el comando funciona, ejecutamint update. -
Ejecuta
mint statusantes de iniciar la autenticación. Si ya muestra una organización, conserva la sesión existente y no crees otra cuenta. -
Si el usuario tiene una cuenta, ejecuta
mint login. Si no la tiene, pide su nombre, apellido, empresa y correo electrónico. Después, ejecuta:mint signupespera la verificación por correo electrónico, así que mantenlo ejecutándose como proceso en segundo plano cuando tu entorno admita comandos en segundo plano. Indica al usuario que haga clic en el enlace de verificación y apruebe la CLI en el navegador. Nunca inventes datos de registro. -
Después de que el usuario complete la verificación y la configuración inicial, ejecuta
mint statusde nuevo. Confirma que indique su correo electrónico, organización y subdominio. Si la organización existe pero no aparece ningún subdominio, pídele al usuario que termine de seleccionar o conectar un repositorio de GitHub en la pestaña del navegador de configuración inicial. Después, vuelve a intentarlo. -
Si el usuario tiene un repositorio de documentación existente, clónalo o ábrelo. Conserva su contenido. Para un proyecto local nuevo, crea la estructura en un directorio nuevo y vacío con
mint new <directory> --name <name> --theme <theme>omint new <directory> --template <template-name>. Pregunta qué tema o plantilla prefiere si no lo ha especificado. No uses--forceen un directorio que contenga archivos del usuario. -
Ejecuta
mint dev --no-opendesde el directorio que contienedocs.jsoncomo un proceso en segundo plano. Confirma que la URL local se cargue, comunícasela al usuario y detén el proceso cuando ya no sea necesario. -
Ejecuta
mint validateymint broken-links. Corrige los problemas causados por tus cambios antes de continuar. - Si un repositorio de Git respalda el proyecto y el usuario pidió desplegarlo, haz commit y push de los cambios. Un push a la rama de producción activa un despliegue. No sobrescribas un repositorio existente con contenido inicial.
-
Ejecuta
mint statuspara obtener el subdominio configurado y verifica quehttps://<subdomain>.mintlify.sitese cargue antes de informar que el despliegue se completó.
-
Ejecuta
- Ve al directorio de tu documentación.
-
(Opcional) Añade a tu proyecto el archivo
AGENTS.mdque aparece más abajo. -
Ejecuta
codexpara iniciar una sesión.
Usa Codex con Mintlify
AGENTS.md de tu repositorio para comprender las reglas y convenciones específicas del proyecto antes de empezar a trabajar. Puedes colocar un AGENTS.md en la raíz de tu repositorio de documentación para darle a Codex contexto sobre los componentes de Mintlify, tus estándares de redacción y cómo estructuras tu documentación.
Codex detecta archivos AGENTS.md en varios niveles:
- Instrucciones globales en
~/.codex/AGENTS.mdse aplican a todos tus proyectos. - Instrucciones del proyecto en la raíz de tu repositorio (o en cualquier subdirectorio) se aplican al trabajo realizado en ese ámbito.
AGENTS.md en la raíz de tu repositorio de documentación y haz commit para que todas las personas colaboradoras se beneficien del mismo contexto. Consulta AGENTS.md en la documentación de Codex para conocer todos los detalles.
Ejemplo de AGENTS.md
- Estándares de redacción: Actualiza las pautas de lenguaje para alinearlas con tu guía de estilo.
- Patrones de componentes: Agrega componentes específicos del proyecto o modifica los ejemplos existentes.
- Ejemplos de código: Reemplaza los ejemplos genéricos con llamadas y respuestas reales de la API para tu producto.
- Preferencias de estilo y tono: Ajusta la terminología, el formato y otras reglas.
AGENTS.md en la raíz de tu repositorio de documentación.
AGENTS.md
Trabajar con Codex
AGENTS.md en su lugar, Codex lo detecta automáticamente cuando inicias una sesión en tu repositorio de documentación.
Ejemplos de indicaciones
Mejora con el servidor MCP
~/.codex/config.toml:
codex para que el cambio de configuración surta efecto. Para confirmar que el servidor MCP está conectado, pregúntale a Codex Which MCP servers do you have access to?: debería enumerar la entrada que acabas de añadir.
Usar config.toml registra el servidor MCP para todas las sesiones de Codex en tu equipo. La indicación de skill y MCP en sesión mostrada anteriormente carga el mismo contexto bajo demanda dentro de una sola sesión: úsala para una ejecución puntual o cuando no puedas editar config.toml.
Consulta Model Context Protocol para obtener más información sobre los servidores Search MCP y cómo encontrar el endpoint MCP de tu sitio.