Railagent

Fornece fluxos de trabalho estruturados e ferramentas para agentes de IA que trabalham com projetos de desenvolvimento de software, com foco especializado em aplicações Rails.

Documentação

Railagent - Servidor MCP para Fluxos de Trabalho de Agentes de IA

Um servidor Model Context Protocol (MCP) que fornece fluxos de trabalho estruturados e ferramentas para agentes de IA que trabalham com projetos de desenvolvimento de software, com foco especializado em aplicações Rails.

O Que Isso Faz

O Railagent fornece aos agentes de IA um sistema abrangente de fluxo de trabalho para desenvolvimento de software. Ele guia os agentes por todo o ciclo de vida do desenvolvimento, desde a coleta de requisitos até a implementação, garantindo resultados consistentes e de alta qualidade.

Como Funciona

Para Novos Projetos

  1. Requisitos Funcionais: Use a ferramenta de requisitos funcionais para coletar as informações necessárias sobre o projeto (propósito, usuários, capacidades, fluxos de trabalho, contexto, casos extremos)
  2. Documento de Requisitos do Produto (PRD): Gere um PRD completo a partir dos requisitos funcionais, dividindo o projeto em funcionalidades e histórias de usuário
  3. Documento de Requisitos de Funcionalidade (FRD): Para cada funcionalidade, crie um FRD detalhado que divida grandes funcionalidades em unidades individuais do tamanho de PRs
  4. Documento de Design de Tarefas (TDD): Transforme o FRD em um plano de implementação com subtarefas específicas, onde cada subtarefa corresponde a um commit

Para Sistemas Existentes/Complexos

  • Pule diretamente para a etapa 4 (TDD) acima quando você tiver uma compreensão clara do que precisa ser construído

Fluxo de Trabalho de Implementação

  1. Inicializar Tarefas: Chame a ferramenta de inicialização para configurar subtarefas com base no seu plano de implementação TDD (armazenado em .cursor/scratch/tasks/)
  2. Executar Tarefas: Use a ferramenta de execução para trabalhar em cada tarefa individualmente. Cada tarefa representa exatamente um commit, e o agente aguarda revisão antes de commitar
  3. Acompanhar Progresso: O progresso é mantido em .cursor/scratch/todo.md com notas e atualizações de status

Todos os documentos e tarefas são armazenados automaticamente na pasta .cursor/scratch/ para fácil acesso e organização.

Ferramentas Disponíveis

Ferramentas de Documentação

  • build_functional_requirements: Coleta requisitos abrangentes do projeto
  • build_prd: Gera Documentos de Requisitos do Produto a partir de requisitos funcionais
  • build_frd: Cria Documentos de Requisitos de Funcionalidade para funcionalidades específicas
  • build_tdd: Divide funcionalidades em planos de implementação detalhados com subtarefas em nível de commit
  • build_architecture: Gera documentação abrangente de arquitetura

Ferramentas de Fluxo de Trabalho

  • initialize_task: Configura subtarefas de implementação a partir de planos TDD
  • execute_task: Executa tarefas individuais com pontos de verificação de revisão

Instruções de Configuração

1. Configurar o Cliente MCP

Adicione ao seu arquivo mcp.json:

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

2. Reinicie Seu Cliente MCP

Reinicie seu cliente MCP para carregar o novo servidor.

Observação: A imagem Docker será baixada automaticamente do DockerHub no primeiro uso. Não é necessária instalação manual ou clonagem de repositório!

Estrutura do Projeto

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

Desenvolvimento

Usando a Imagem Pré-construída

A maneira mais fácil de usar o Railagent é com a imagem Docker pré-construída:

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

Desenvolvimento Local

Se você quiser contribuir ou modificar o código:

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

Construindo Sua Própria Imagem

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

Contribuindo

  1. Faça um fork do repositório
  2. Crie sua branch de funcionalidade (git checkout -b feature/amazing-feature)
  3. Faça commit das suas alterações (git commit -m 'Add some amazing feature')
  4. Envie para a branch (git push origin feature/amazing-feature)
  5. Abra um Pull Request

Licença

Este projeto é licenciado sob os termos especificados no arquivo LICENSE.