Forked from yazeed/multi-agent-system-requirements-template.md
Created
April 17, 2025 18:33
-
-
Save MFD3000/d750676c1f793296d9001c6c16c5f31b to your computer and use it in GitHub Desktop.
Revisions
-
yazeed revised this gist
Mar 11, 2025 . 1 changed file with 1 addition and 1 deletion.There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -37,7 +37,7 @@ Detail the complete agent journey through the system: - 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] -
Mar 11, 2025 . 1 changed file with 0 additions and 0 deletions.There are no files selected for viewing
File renamed without changes. -
Mar 11, 2025 .There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -0,0 +1,60 @@ # 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] - 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]