Skip to content

Instantly share code, notes, and snippets.

@yazeed
Last active March 11, 2025 18:01
Show Gist options
  • Save yazeed/40242a2d8255d4f14eb41b3f3d2ef67f to your computer and use it in GitHub Desktop.
Save yazeed/40242a2d8255d4f14eb41b3f3d2ef67f to your computer and use it in GitHub Desktop.

Multi-Agent System Requirements Document

You are an expert AI systems architect. Create a comprehensive, detailed implementation plan for the following multi-agent system:

Project Overview

[Provide a concise description of your multi-agent system concept - what it does and the primary value it delivers]

Target Agents & Use Cases

  • Who will interact with this system? [Types of agents]
  • What are their primary goals? [Agent objectives]
  • What problems does this solve for them? [Issues addressed]

Core Functionality

Provide complete details for ALL required capabilities:

  • Capability 1: [Description with complete requirements]
  • Capability 2: [Description with complete requirements]
  • Capability 3: [Description with complete requirements]
  • [Continue with all needed capabilities]

Interaction Interface Requirements

  • Interaction style: [Message-based/Event-driven/etc]
  • Protocol requirements: [Specific protocols or standards]
  • Key components needed: [Message queues/Service buses/etc]

Data Model

  • Describe all entities and their relationships: [Entities and connections]
  • Specify data types and validation rules: [Data specifications]
  • Include authentication/authorization model if applicable: [Security model]

Agent Flows

Detail the complete agent journey through the system:

  • Entry point: [How agents start or join]
  • Authentication: [If applicable]
  • Main interaction: [Step-by-step flow]
  • Edge cases: [How to handle failures/exceptions]
  • Success states: [What completion looks like]

Technical Requirements

  • Agent framework: [Specific multi-agent platform, e.g. Agno, OpenAI Swarm, LangGraph, Microsoft Autogen, CrewAI, Vertex AI, or Langflow]
  • Backend requirements: [If applicable]
  • APIs/Integrations needed: [List all external services]
  • Performance expectations: [Throughput/Response times]
  • Security considerations: [Agent authentication/Data protection]

Accessibility & Compliance

  • Required accessibility standards: [Agent interaction standards, if applicable]
  • Compliance requirements: [GDPR/CCPA/etc if applicable]

Examples & Inspiration

  • Similar systems: [Descriptions or references]
  • Specific elements to emulate: [Capabilities/Interactions]

Implementation Priorities

  • Must-have capabilities: [Critical functionality]
  • Nice-to-have capabilities: [Secondary importance]
  • Future enhancements: [Post-initial release]

Additional Context

[Any other information that would help create the best possible implementation]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment