Railagent

Proporciona flujos de trabajo estructurados y herramientas para agentes de IA que trabajan con proyectos de desarrollo de software, con un enfoque especializado en aplicaciones Rails.

Documentación

Railagent - Servidor MCP para Flujos de Trabajo de Agentes de IA

Un servidor de Protocolo de Contexto de Modelo (MCP) que proporciona flujos de trabajo y herramientas estructurados para agentes de IA que trabajan con proyectos de desarrollo de software, con un enfoque especializado en aplicaciones Rails.

Qué Hace Esto

Railagent proporciona a los agentes de IA un sistema integral de flujo de trabajo para el desarrollo de software. Guía a los agentes a través de todo el ciclo de vida del desarrollo, desde la recopilación de requisitos hasta la implementación, garantizando resultados consistentes y de alta calidad.

Cómo Funciona

Para Proyectos Nuevos

  1. Requisitos Funcionales: Utilice la herramienta de requisitos funcionales para recopilar la información necesaria sobre el proyecto (propósito, usuarios, capacidades, flujos de trabajo, contexto, casos límite)
  2. Documento de Requisitos de Producto (PRD): Genere un PRD completo a partir de los requisitos funcionales, desglosando el proyecto en funcionalidades e historias de usuario
  3. Documento de Requisitos de Funcionalidad (FRD): Para cada funcionalidad, cree un FRD detallado que divida las funcionalidades grandes en unidades del tamaño de un PR individual
  4. Documento de Diseño de Tareas (TDD): Transforme el FRD en un plan de implementación con subtareas específicas, donde cada subtarea corresponde a un commit

Para Sistemas Existentes/Complejos

  • Salte directamente al paso 4 (TDD) anterior cuando tenga una comprensión clara de lo que necesita construirse

Flujo de Trabajo de Implementación

  1. Inicializar Tareas: Llame a la herramienta de inicialización para configurar las subtareas según su plan de implementación TDD (almacenado en .cursor/scratch/tasks/)
  2. Ejecutar Tareas: Utilice la herramienta de ejecución para trabajar en cada tarea individualmente. Cada tarea representa exactamente un commit, y el agente espera la revisión antes de hacer el commit
  3. Seguimiento del Progreso: El progreso se mantiene en .cursor/scratch/todo.md con notas y actualizaciones de estado

Todos los documentos y tareas se almacenan automáticamente en la carpeta .cursor/scratch/ para facilitar el acceso y la organización.

Herramientas Disponibles

Herramientas de Documentación

  • build_functional_requirements: Recopila requisitos integrales del proyecto
  • build_prd: Genera Documentos de Requisitos de Producto a partir de requisitos funcionales
  • build_frd: Crea Documentos de Requisitos de Funcionalidad para funcionalidades específicas
  • build_tdd: Desglosa las funcionalidades en planes de implementación detallados con subtareas a nivel de commit
  • build_architecture: Genera documentación integral de arquitectura

Herramientas de Flujo de Trabajo

  • initialize_task: Configura subtareas de implementación a partir de planes TDD
  • execute_task: Ejecuta tareas individuales con puntos de control de revisión

Instrucciones de Configuración

1. Configurar el Cliente MCP

Agregue a su archivo mcp.json:

{
  "mcpServers": {
    "Railagent": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "cestbalez/railagent:latest"
      ]
    }
  }
}

2. Reiniciar Su Cliente MCP

Reinicie su cliente MCP para cargar el nuevo servidor.

Nota: La imagen de Docker se descargará automáticamente desde DockerHub en el primer uso. ¡No se requiere instalación manual ni clonación del repositorio!

Estructura del Proyecto

railagent/
├── app.rb                      # Main application entry point
├── lib/                        # Tool implementations
│   ├── docs/                   # Documentation tools
│   └── workflow/               # Workflow management tools
├── prompts/                    # Workflow prompts and templates
│   ├── docs/                   # Documentation workflow prompts
│   └── workflow/               # Implementation workflow templates
├── Dockerfile                  # Docker configuration
├── Gemfile                     # Ruby dependencies
└── README.md                   # This file

Desarrollo

Usando la Imagen Preconstruida

La forma más fácil de usar Railagent es con la imagen Docker preconstruida:

docker run -i --rm cestbalez/railagent:latest

Desarrollo Local

Si desea contribuir o modificar el código:

git clone <your-repo-url>
cd railagent
bundle install
ruby app.rb

Construyendo Su Propia Imagen

git clone <your-repo-url>
cd railagent
docker build -t railagent .

Contribuciones

  1. Haga un fork del repositorio
  2. Cree su rama de funcionalidad (git checkout -b feature/amazing-feature)
  3. Haga commit de sus cambios (git commit -m 'Add some amazing feature')
  4. Haga push a la rama (git push origin feature/amazing-feature)
  5. Abra un Pull Request

Licencia

Este proyecto está licenciado bajo los términos especificados en el archivo LICENSE.