Skip to content

README.md

Latest commit

 

History

History
87 lines (62 loc) · 4.09 KB

README.md

File metadata and controls

87 lines (62 loc) · 4.09 KB

🤖 Multi-Agent Engineering Framework (MAEF)

🌟 The Future of Agentic Coding

The Multi-Agent Engineering Framework (MAEF) is a production-hardened infrastructure designed to transform AI assistants into a high-functioning Engineering Agency. This framework enforces Principal Engineer Standards (2026) through a system of recursive laws, specialized skills, and immutable workflows.

Designed for complex, multi-repository full-stack projects, MAEF ensures that every line of code is type-safe, modular, and architecturally sound, regardless of which agent executes the task.

🏛️ Core Pillar Architecture

1. ⚖️ The Laws (.agent/rules/)

The foundational "Constitution" of your project.

  • Implementation Laws: Strict 6-step integration flows for Frontend and Backend.
  • Intent Clarification Law: A mandatory protocol to resolve ambiguous requests (e.g., "optimize", "refactor") by classifying them into dedicated Optimization Vectors.
  • Unified Response Structure: A global directive enforcing a strict ApiResponse<T> shape across all system boundaries.

2. 🎭 Specialized Skills (.agent/skills/)

Personas with granular expertise and mandatory audit checklists.

  • Architect: Owns modularity, decoupling, and domain boundaries.
  • Software Engineer: Owns execution, type-safety, and SOLID principles.
  • QA Expert: Owns boundary defense, error boundaries, and stability.
  • Integration Architect: Owns vendor-agnostic 3rd party integrations (Stripe, Twilio, WhatsApp).
  • Project Manager: Owns sequencing, implementation planning, and requirement translation.

3. 📑 Hardened Workflows (.agent/workflows/)

Immutable "Runbooks" for lifecycle management.

  • Full-Stack Coordination: A directory-agnostic bridge to choreographer frontend and backend repo changes.
  • Feature Sculpting: End-to-end guides for carving new features into existing modules.

4. 📝 Request Templates (.agent/templates/)

The "API for Humans." A library of 20+ pre-filled prompts that summon specific roles and workflows.

🚀 Getting Started (Framework Scaffolding)

To use this framework in any project, scafold the following directory structure:

Frontend Scaffold (client/.agent/)

  • rules/project_laws.md: Define React-specific architectural rules.
  • skills/: Persona files for UX, QA, and Frontend Engineering.
  • templates/: Feature implementation and bug-fix prompts.

Backend Scaffold (server/.agent/)

  • rules/project_laws.md: Define NestJS/Server-specific architectural rules.
  • skills/: Persona files for DB Design, Security, and Backend Engineering.
  • templates/: Schema migration and module implementation prompts.

🛠️ Usage Pattern: "@Mention Orchestration"

MAEF leverages @Role and @Workflow mentions to guide the agent perfectly.

Example: Implementing a New Billing Module

Instead of saying "Add billing," use the new-module.md template:

### 🚀 Request: New Feature Implementation

**As a**: @[server/.agent/skills/project_manager.md]
**Action**: Analyze requirements and produce a 6-step implementation plan.
**Execution**: Implement as @[server/.agent/skills/software_engineer.md] following @[server/.agent/workflows/create-new-backend-feature.md].

**Feature Name**: Stripe Subscription Engine
**Integrations**: Prisma (Models), BullMQ (Webhooks), Stripe-SDK.

🛡️ Engineering Compliance (Audit Mode)

Every agent execution includes a Mandatory Audit Checklist:

  • Zod/Class-Validator schemas enforced.
  • Unified response structure applied.
  • Zero-Waste UI principles followed.
  • Transactionality and circuit breakers implemented.

📈 Scalability & Portability

  • Repo Agnostic: Laws and workflows are written to be resilient to folder name changes (server vs backend).
  • Framework Native: Optimized for React/Vite (Frontend) and NestJS/Prisma (Backend).
  • Standardized Communication: Uses the same schema for internal and external error reporting.

"Consistency beats cleverness. Logic drives state. Laws define reality." — MAEF Principle