Agents Rules

Generador automático de documentación Agents.md para proyectos Next.js con integración MCP (Model Context Protocol).

Author: Jorge Castillo
License: MIT

🎯 Características

• ✅ Detección automática de la estructura del proyecto Next.js
• ✅ Generación inteligente de archivos Agents.md según las carpetas detectadas
• ✅ Skills configurables para diferentes roles (Frontend, Backend, UX/UI)
• ✅ Integración MCP para uso directo con agentes de IA (Cursor, Claude, etc.)
• ✅ Templates completos con mejores prácticas y reglas de desarrollo

📦 Instalación

npm install -g agents-rules

O como dependencia de desarrollo:

npm install --save-dev agents-rules

🚀 Uso Básico

Generar Documentación

# Genera todos los archivos según la estructura detectada
npx agents-rules generate

# Generar solo skills específicos
npx agents-rules generate --skills Frontend-react-skill Backend-node-skill

# Generar todos los skills disponibles
npx agents-rules generate --all-skills

Listar Skills Disponibles

npx agents-rules list-skills

📁 Estructura Generada

El comando generate crea la siguiente estructura:

tu-proyecto/
├── AGENTS.md                    # Orquestador principal
├── components/
│   └── AGENTS-UI.md            # Reglas para componentes UI
├── app/ (o pages/)
│   └── AGENTS-PATTERN.md       # Reglas de patrones de diseño
├── api/
│   └── AGENTS-API.md           # Reglas para APIs
├── services/
│   └── AGENTS-SERVICES.md      # Reglas para servicios
├── utils/ (o lib/)
│   └── AGENTS-HELPERS.md       # Reglas para utilidades
└── skills/
    ├── FRONTEND-REACT-SKILL.md
    ├── FRONTEND-ANGULAR-SKILL.md
    ├── BACKEND-NODE-SKILL.md
    └── DISEÑADOR-UXUI-SKILL.md

🔌 Integración MCP

Configuración en Cursor

Agrega la siguiente configuración en tu archivo de configuración MCP de Cursor:

{
  "mcpServers": {
    "agents-rules": {
      "command": "npx",
      "args": ["agents-rules", "mcp-server"],
      "cwd": "${workspace}"
    }
  }
}

Recursos Disponibles (Resources)

El servidor MCP expone los siguientes recursos:

• agents://root/AGENTS.md - Orquestador principal
• agents://components/AGENTS-UI.md - Reglas de UI
• agents://app/AGENTS-PATTERN.md - Reglas de patrones
• agents://api/AGENTS-API.md - Reglas de API
• agents://services/AGENTS-SERVICES.md - Reglas de servicios
• agents://utils/AGENTS-HELPERS.md - Reglas de utilidades
• agents://skills/[SKILL-NAME].md - Skills específicos

Herramientas Disponibles (Tools)

1. generate_docs

   • Genera automáticamente todos los archivos Agents.md
   • Parámetros opcionales: includeSkills (array de nombres de skills)

2. detect_structure

   • Detecta la estructura del proyecto Next.js
   • Retorna información sobre carpetas disponibles

3. get_skill

   • Obtiene el contenido de un skill específico
   • Parámetros: skillName (string)

Ejemplo de Uso con MCP

Cuando un agente de IA necesite información sobre cómo crear un componente React, puede:

1. Consultar el resource agents://components/AGENTS-UI.md
2. Consultar el resource agents://skills/FRONTEND-REACT-SKILL.md
3. Usar la tool generate_docs para regenerar la documentación

📚 Skills Disponibles

Frontend-react-skill.md

Habilidades y conocimientos de un Senior Frontend Developer con React:

• React Core y Hooks avanzados
• Next.js (App Router y Pages Router)
• State Management
• Performance Optimization
• Clean Code y SOLID
• Testing
• Y más...

Frontend-angular-skill.md

Habilidades y conocimientos de un Senior Frontend Developer con Angular:

• Angular Core
• TypeScript Mastery
• RxJS
• Routing
• Testing
• Y más...

Backend-node-skill.md

Habilidades y conocimientos de un Senior Backend Developer:

• Node.js Core
• Next.js Backend (API Routes, Server Actions)
• Database (SQL y NoSQL)
• Security
• Performance
• Y más...

Diseñador-uxui-skill.md

Habilidades y conocimientos de un Diseñador UX/UI:

• Fundamentos de Diseño
• UX Research
• UI Design
• Design Systems
• Herramientas
• Y más...

🎨 Personalización

Templates

Los templates se encuentran en src/templates/ y pueden ser personalizados. Cada template soporta:

• Variables: {{variable}}
• Condicionales: {{#if condition}}...{{/if}}
• Estructura del proyecto: {{structure}}

Agregar Nuevos Skills

Para agregar un nuevo skill:

1. Crea un template en src/templates/[nombre]-skill.template
2. Agrega la configuración en src/generators/skills-generator.ts

🛠️ Desarrollo

Clonar y Desarrollar

git clone <repo>
cd agents-rules
npm install
npm run build

Scripts Disponibles

• npm run build - Compila TypeScript
• npm run dev - Modo desarrollo con watch
• npm start - Ejecuta la versión compilada

📝 Licencia

MIT

📧 Soporte

Para problemas, preguntas o sugerencias, contacta al autor por email:

Email: [email protected]

💡 Sugerencias y Mejoras

Si tienes ideas para mejorar este paquete, no dudes en contactarme por email. Tu feedback es muy valioso!

👤 Autor

Jorge Castillo

• GitHub: JorgeCastilloMakers
• Email: [email protected]

📄 Licencia

Este proyecto está bajo la Licencia MIT. Ver el archivo LICENSE para más detalles.

Hecho con ❤️ para mejorar la experiencia de desarrollo con agentes de IA