Tu asistente especializado para documentar con Mermaid
¿Te has imaginado tener un Copilot que entienda exactamente cómo es tu proyecto y que genere documentación con diagramas Mermaid de manera automática? Bueno, eso no es ciencia ficción. Con los Custom agents en GitHub Copilot, puedes entrenar a tu asistente IA para que se comporte como un especialista en documentación adaptado específicamente a tu repositorio.
En este artículo te voy a mostrar paso a paso cómo crear tu propio Custom Agent especializado en documentar arquitecturas con Mermaid. ¡Vamos a ello!
¿Qué es un custom agent en GitHub Copilot?
Imagina esto: GitHub Copilot es genial, pero es genérico. Funciona con cualquier código, en cualquier proyecto. Los Custom agents son como entrenar a ese asistente para que se especialice en tu forma de trabajar, tu stack tecnológico y tus necesidades específicas.
Un Custom agent es básicamente:
- 📋 Un fichero Markdown en
.github/agents/ - 🧠 Instrucciones detalladas sobre cómo debe comportarse
- 🎯 Un «persona» especializado que entiende tu proyecto
- 🚀 Automatización inteligente de tareas repetitivas
Cuando los usuarios interactúan con tu agente personalizado, Copilot seguirá esas instrucciones específicas en lugar de usar sus comportamientos por defecto.

Por qué esto es revolucionario para la documentación
La documentación es la tarea más odiada por los developers. ¿Por qué? Porque es:
- 😫 Aburrida
- 🔄 Repetitiva
- ⏰ Consume mucho tiempo
- 🤔 Fácil de olvidar
Con Custom Agents + Mermaid, puedes:
- 🤖 Generar documentación automáticamente
- 📊 Crear diagramas sin tocar una herramienta gráfica
- 🎨 Mantener consistencia en toda tu documentación
- ⚡ Acelerar el onboarding de nuevos developers
Paso 1: Entender la estructura de un custom agent
Todo Custom Agent es un fichero Markdown (.md) que vive en .github/agents/. Tiene dos secciones principales:
La metadata (YAML frontmatter)
---
name: Mi-Primer-Agente
description: Un agente que genera documentación increíble
---
Las instrucciones (El resto del archivo)
# Mi Primer Agente
Aquí va toda la lógica, los pasos, las mejores prácticas...
Eso es todo. Un fichero Markdown con estructura. Sencillo, ¿verdad?
Paso 2: Crear la estructura de carpetas
Primero, asegúrate de que tu repositorio tenga esta estructura:
tu-repo/
├── .github/
│ └── agents/
│ └── tu-primer-agente.md ← Tu custom agent aquí
├── docs/
│ ├── diagrams/ ← Los diagramas generados
│ └── screenshots/ ← Las capturas (opcional)
└── README.md
Si no existe .github/agents/, créala. Es tan simple como:
mkdir .github\agents
Paso 3: Diseña el comportamiento de tu agente
Este es el paso más importante. Aquí defines qué va a hacer tu agente y cómo lo va a hacer.
Piénsalo como escribir instrucciones para un junior muy inteligente:
# Tu Nombre de Agente Bien Descriptivo
## Descripción
Una frase clara sobre qué hace este agente.
## Instructions
Aquí le dices exactamente qué hacer, paso a paso.
### Workflow
1. **Primer paso** - Explica qué debe analizar
2. **Segundo paso** - Qué conexiones debe encontrar
3. **Tercer paso** - Qué debe generar como output
Paso 4: Define el workflow detallado
Este es donde la magia ocurre. Voy a darte un ejemplo real basado en documentación de Azure Functions:
### Workflow
1. **Analizar la estructura del repositorio**
- Examina todas las carpetas y subcarpetas
- Identifica el propósito de cada componente
- Mapea las dependencias entre servicios
2. **Extrae información técnica**
- Lee el archivo `.csproj` para dependencias
- Analiza archivos de configuración
- Busca patrones de arquitectura
3. **Crea el diagrama Mermaid**
- Usa la información extraída
- Define componentes y sus conexiones
- Genera la sintaxis Mermaid correcta
4. **Genera la documentación Markdown**
- Estructura clara con headings
- Incluye snippets de código real
- Embebé el diagrama generado
Paso 5: Integra herramientas especializadas
Aquí es donde conectas tu agente con capacidades específicas. En nuestro caso, Mermaid:
### Generación de Diagramas con Mermaid
Para crear diagramas, tu agente debe usar la herramienta de MCP (Model Context Protocol):
- **Herramienta**: `mcp_mcp-mermaid_generate_mermaid_diagram`
- **Input**: Sintaxis Mermaid que describe tu arquitectura
- **Output**: Imagen SVG o PNG
Ejemplo de instrucciones:
"Cuando necesites crear un diagrama:
1. Genera la sintaxis Mermaid basada en la arquitectura analizada
2. Usa tema 'neutral' para mejor legibilidad
3. Guarda el resultado en `docs/diagrams/` con timestamp
4. Embebé la imagen en la documentación final"
Paso 6: Crea ejemplos y patrones
Los agentes aprenden mejor con ejemplos. Proporciona patrones específicos:
## Patrones de Ejemplo
### Patrón de Diagrama de Flujo (Functions + Services)
```mermaid
flowchart LR
subgraph Functions["Azure Functions"]
F1["Function A<br/>(HTTP)"]
F2["Function B<br/>(Timer)"]
end
subgraph Services["Services"]
S1["GraphService"]
S2["StorageService"]
end
F1 --> S1
F2 --> S2
S1 --> |"Microsoft Graph API"| MG["External API"]
Cómo debería verse la salida
- Archivo Markdown con estructura clara
- Diagramas embebidos
- Referencias a código real
- Timestamps en los nombres de archivos
---
## Paso 7: Define la Salida (Output)
Especifica exactamente cómo quieres que sea el resultado final:
```markdown
### Generación de Archivos
El agente debe crear:
1. **Archivo de documentación principal**
- Ubicación: `docs/SolutionOverview-yyyyMMdd-hhmmss.md`
- Formato: Markdown con estructura coherente
- Contenido: Overview, Arquitectura, Componentes, etc.
2. **Diagramas Mermaid**
- Ubicación: `docs/diagrams/architecture-yyyyMMdd-hhmmss.svg`
- Formato: SVG renderizado
- Referenciado desde la documentación
3. **Screenshots (opcional)**
- Ubicación: `docs/screenshots/`
- Con confirmación del usuario
Paso 8: Añade notas de calidad
Los agentes también necesitan saber qué nivel de calidad esperas:
### Estándares de Calidad
- ✅ Redacción clara y profesional
- ✅ Documentación sin verbosidad innecesaria
- ✅ Código real, no pseudocódigo
- ✅ Diagramas precisos y legibles
- ✅ Referencias cruzadas entre componentes
- ✅ Explicación de integraciones externas (APIs, servicios)
- ✅ Mencionar tecnologías clave (.NET, Azure, etc.)
Ejemplo completo: Custom agent de documentación con Mermaid
Aquí está el Custom Agent completo para documentar Azure Functions:
---
name: Azure-Functions-Documenter-Mermaid
description: Analiza soluciones .NET Azure Functions y genera documentación con diagramas Mermaid
---
# Azure Functions Solution Documenter con Mermaid
## Descripción
Este agente especializado analiza proyectos Azure Functions y genera documentación técnica completa con diagramas de arquitectura en Mermaid.
## Instrucciones
Eres un experto en Azure Functions y documentación técnica. Tu tarea es convertir código complejo en documentación hermosa y comprensible.
### Workflow
1. **Escanea la Estructura**
- Lee todas las carpetas: `Functions`, `Services`, `Models`, `Configuration`, `IoC`
- Identifica el propósito de cada componente
- Mapea dependencias y flujos de datos
2. **Extrae Información Técnica**
- Analiza triggers de Azure Functions
- Identifica servicios y sus responsabilidades
- Extrae configuraciones y patrones de seguridad
- Revisa integraciones externas
3. **Genera Diagrama Mermaid**
- Crea flujo de datos entre Functions y Services
- Muestra integraciones externas (APIs, Storage, etc.)
- Usa colores y formas coherentes
4. **Produce Documentación**
- Archivo: `docs/SolutionOverview-yyyyMMdd-hhmmss.md`
- Estructura: Overview → Arquitectura → Diagrama → Componentes → Features
- Incluye snippets de código real
- Embebé el diagrama Mermaid
### Estándares de Calidad
- Redacción técnica pero accesible
- Diagramas claros y precisos
- Referencias a código real
- Explicación de decisiones de diseño
Paso 9: Prueba tu agente localmente
GitHub proporciona una herramienta CLI para probar agentes localmente:
# Instala la CLI de GitHub Copilot
gh extension install github/gh-copilot
# Prueba tu agente
gh copilot custom-agent test .github/agents/tu-agente.md
Paso 10: «Deploya» tu agente
Una vez esté funcionando perfectamente:
- Commit y push a tu rama principal:
git add .github/agents/
git commit -m "feat: add custom documentation agent"
git push origin main
- El agente está VIVO 🚀
- Cualquier usuario en el repositorio puede acceder a él
- Simplemente lo seleccionan en el chat de Copilot
- ¡Automatización mágica!
Tips pro: Consejos avanzados
1️⃣ Mantén las instrucciones claras y concisas
✅ BIEN: "Analiza el archivo .csproj y extrae todas las dependencias"
❌ MAL: "Mira cómo es el proyecto"
2️⃣ Usa ejemplos de salida esperada
Muestra exactamente qué quieres:
### Ejemplo de Diagrama Esperado
```mermaid
graph LR
A[Entrada] --> B[Procesamiento]
B --> C[Salida]
«»»
3️⃣ Define límites y excepciones
### Limitaciones
- Este agente se especializa en proyectos .NET
- Requiere estructura estándar de carpetas
- Genera documentación en Markdown
4️⃣ Crea versiones
---
name: Solution-Documenter-v2
version: "2.0.0"
---
5️⃣ Incluye troubleshooting
### ¿Qué hacer si algo sale mal?
**Si el agente no encuentra componentes:**
- Verifica que las carpetas existan
- Revisa que los archivos tengan las extensiones correctas
**Si los diagramas no se ven bien:**
- Simplifica la sintaxis Mermaid
- Prueba con menos elementos en el diagrama
El futuro: Custom agents en tu organización
Imagina esto:
- 🏢 Custom Agent para APIs REST: Genera documentación OpenAPI automáticamente
- 📦 Custom Agent para Monorepos: Entiende la estructura completa de tu monorepositorio
- 🧪 Custom Agent para Testing: Analiza coverage y genera reportes
- 🔐 Custom Agent para Security: Audita código e identifica vulnerabilidades
Cada agente es específico para tu contexto. No es AI genérica; es IA entrenada en tu dominio.
Conclusión
Los Custom Agents en GitHub Copilot son la evolución natural de la IA en desarrollo:
- ✨ Automatización inteligente sin código
- 🎯 Especialización en tu contexto específico
- ⚡ Productividad de equipo multiplicada
- 📚 Documentación siempre actualizada
Ya no tienes que elegir entre:
- Documentación buena O rápida
- Diagramas bonitos O mantenidos
- Onboarding fácil O exactitud técnica
Con Custom Agents, puedes tenerlo todo.
El futuro de la documentación no es esperar a que alguien la escriba. Es que tu AI especializado la genere. Y ahora ya sabes cómo hacerlo. 🚀
Recursos
- 📖 GitHub Custom Agents Documentation
- 🎨 Mermaid.js Official Docs
- 🛠️ GitHub Copilot CLI
- 💡 MCP (Model Context Protocol) Docs
¿Necesitas ayuda creando tu primer Custom agent? Comparte tu caso de uso en los comentarios y te ayudaré a diseñar el agente perfecto para tu proyecto. 💪





Deja una respuesta
Lo siento, debes estar conectado para publicar un comentario.