Personaliza Gemini con archivos AGENTS.md

Proporciona instrucciones personalizadas a Gemini en Android Studio para que las siga con uno o más archivos AGENTS.md. Los archivos AGENTS.md se colocan junto con los demás archivos de tu base de código, por lo que es sencillo registrarlos en tu sistema de control de versiones (VCS) y compartir instrucciones específicas del proyecto, reglas de estilo de codificación y otras orientaciones con todo tu equipo.

Para comenzar, sigue estos pasos:

  1. Crea un archivo AGENTS.md en cualquier lugar del sistema de archivos de tu proyecto. Cuando envías una pregunta, Gemini analiza el directorio actual y todos los directorios superiores en busca de archivos AGENTS.md. Para obtener más información, consulta Cómo funcionan los archivos AGENTS.md.

  2. Agrega tus instrucciones. Escribe tus instrucciones con Markdown. Para facilitar la lectura, considera usar encabezados y viñetas para las diferentes reglas. Consulta las instrucciones de ejemplo.

  3. Guarda y confirma el archivo en tu VCS para compartirlo con tu equipo.

Administra archivos AGENTS.md como contexto

Puedes aplicar o quitar archivos AGENTS.md como contexto para una búsqueda en particular con el panel Contexto del panel de chat. Las opciones de AGENTS.md Files incluyen todos los archivos AGENTS.md del directorio actual y sus directorios superiores.

Administra archivos AGENTS.md como contexto
Figura 1: Administra archivos AGENTS.md como contexto.

Ejemplo de instrucciones

Puedes usar el archivo AGENTS.md para darle instrucciones al agente. A continuación, se incluyen algunos ejemplos, pero las instrucciones que proporciones deben ser específicas para tu proyecto.

  • "La actividad principal es /path/to/MainActivity.kt".
  • "El código para admitir la navegación entre pantallas es path/to/navigation/UiNavigation.kt".
  • "El código que controla las solicitudes HTTP se encuentra en <path>".
  • Arquitectura del proyecto
    • "Coloca toda la lógica empresarial en ViewModels".
    • "Siempre sigue las recomendaciones oficiales de arquitectura, incluido el uso de una arquitectura en capas. Usa un flujo unidireccional de datos (UDF), ViewModels, recopilación de estado de la IU optimizada para ciclos de vida y otras recomendaciones".
  • Bibliotecas preferidas: "Usa la biblioteca <nombre de la biblioteca> para la navegación".
  • Definir nombres de marcadores de posición para servicios de API comunes o terminología interna: "El servicio de backend principal se conoce como 'PhotoSift-API'".
  • Guías de estilo de la empresa: "Todos los componentes de IU nuevos deben compilarse con Jetpack Compose. No sugieras diseños basados en XML".

Modulariza tus archivos AGENTS.md

Puedes dividir los archivos AGENTS.md grandes en archivos más pequeños que se puedan reutilizar en diferentes contextos:

  1. Separa un conjunto de instrucciones y guárdalas en otro archivo Markdown, como style-guidance.md.

  2. Haz referencia a los archivos Markdown más pequeños en un archivo AGENTS.md con el símbolo @ seguido de la ruta de acceso al archivo que deseas importar. Se admiten los siguientes formatos de ruta de acceso:

    • Rutas de acceso relativas:
      • @./file.md: Importar desde el mismo directorio
      • @../file.md: Importar desde el directorio principal
      • @./subdirectory/file.md: Importar desde un subdirectorio
    • Rutas de acceso absolutas: @/absolute/path/to/file.md

Por ejemplo, el siguiente archivo AGENTS.md hace referencia a otros dos archivos de instrucciones:

# My AGENTS.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

Cómo funcionan los archivos AGENTS.md

Gemini analiza automáticamente el directorio actual y los directorios superiores en busca de archivos AGENTS.md y agrega su contenido al comienzo de cada instrucción como preámbulo. Si no tienes un archivo abierto cuando envías una consulta, se incluye de forma predeterminada el archivo AGENTS.md en la raíz del proyecto (si hay uno).

¿Cuál es la diferencia entre los archivos AGENTS.md y las reglas?

Las reglas también te permiten definir instrucciones y preferencias que se aplican a todas las instrucciones. Sin embargo, las reglas se definen en el archivo /.idea/project.prompts.xml de IntelliJ, mientras que los archivos AGENTS.md se guardan junto a tu código fuente y son independientes del IDE. Te recomendamos que uses archivos AGENTS.md si uno de los propósitos principales es compartir las instrucciones con tu equipo.