ACE MCP Server

archive-comprehensive.mdc•22.4 kB

--- description: Comprehensive archiving approach for Level 4 Complex System tasks globs: "**/level4/**", "**/archive/**" alwaysApply: false --- # COMPREHENSIVE ARCHIVING FOR LEVEL 4 TASKS > **TL;DR:** This document outlines a comprehensive archiving approach for Level 4 (Complex System) tasks, ensuring all system knowledge, decisions, implementation details, and lessons learned are preserved for future reference and reuse. ## 🔍 COMPREHENSIVE ARCHIVING OVERVIEW Level 4 Complex System tasks require thorough archiving to preserve system knowledge, design decisions, implementation details, and lessons learned. This systematic archiving process ensures that the organization maintains institutional knowledge and enables future teams to understand, maintain, and extend the system. ```mermaid flowchart TD classDef phase fill:#f9d77e,stroke:#d9b95c,color:#000 classDef artifact fill:#f4b8c4,stroke:#d498a4,color:#000 classDef verification fill:#c5e8b7,stroke:#a5c897,color:#000 Start([Begin Archiving Process]) --> Template[Load Comprehensive Archive Template] Template --> RefDoc[Review Reflection Document] RefDoc --> SysDoc[Create System Documentation] SysDoc --> ArchDoc[Document Architecture and Design] ArchDoc --> ImplDoc[Document Implementation Details] ImplDoc --> APIDoc[Create API Documentation] APIDoc --> DataDoc[Document Data Models and Schemas] DataDoc --> SecDoc[Document Security Measures] SecDoc --> TestDoc[Document Testing Procedures and Results] TestDoc --> DeployDoc[Document Deployment Procedures] DeployDoc --> OpDoc[Create Operational Documentation] OpDoc --> KnowledgeDoc[Create Knowledge Transfer Documentation] KnowledgeDoc --> CrossRef[Create Cross-Reference Documentation] CrossRef --> Archive[Archive All Project Materials] Archive --> UpdateMB[Update Memory Bank] UpdateMB --> Verification{Archiving Verification} Verification -->|Pass| Complete([Archiving Complete]) Verification -->|Fail| Revise[Revise Archiving] Revise --> Verification Template -.-> AT((Archive Template)) SysDoc -.-> SD((System Documentation)) ArchDoc -.-> AD((Architecture Documentation)) ImplDoc -.-> ID((Implementation Documentation)) APIDoc & DataDoc -.-> IntDoc((Interface Documentation)) TestDoc & DeployDoc & OpDoc -.-> OpDocs((Operational Documentation)) class Start,Complete milestone class Template,RefDoc,SysDoc,ArchDoc,ImplDoc,APIDoc,DataDoc,SecDoc,TestDoc,DeployDoc,OpDoc,KnowledgeDoc,CrossRef,Archive,UpdateMB step class Verification verification class AT,SD,AD,ID,IntDoc,OpDocs artifact ``` ## 📋 ARCHIVE TEMPLATE STRUCTURE ### 1. System Overview ```markdown ## System Overview ### System Purpose and Scope [Comprehensive description of the system purpose, scope, and business context] ### System Architecture [Summary of the architecture, including diagrams, patterns, and key design decisions] ### Key Components - Component 1: [Description and purpose] - Component 2: [Description and purpose] - Component 3: [Description and purpose] ### Integration Points [Description of all internal and external integration points] ### Technology Stack [Comprehensive list of all technologies, frameworks, and tools used] ### Deployment Environment [Description of the deployment environment, infrastructure, and configuration] ``` ### 2. Requirements and Design Documentation ```markdown ## Requirements and Design Documentation ### Business Requirements [Comprehensive list of business requirements with traceability] ### Functional Requirements [Detailed functional requirements with implementation mapping] ### Non-Functional Requirements [Non-functional requirements with implementation approaches] ### Architecture Decision Records [Collection of all architecture decision records (ADRs)] ### Design Patterns Used [Catalog of all design patterns with usage examples] ### Design Constraints [Documentation of all design constraints and their impact] ### Design Alternatives Considered [Summary of alternatives considered and reasons for final selections] ``` ### 3. Implementation Documentation ```markdown ## Implementation Documentation ### Component Implementation Details - **Component 1**: - **Purpose**: [Component purpose] - **Implementation approach**: [Implementation details] - **Key classes/modules**: [List with descriptions] - **Dependencies**: [Internal and external dependencies] - **Special considerations**: [Important notes] - **Component 2**: - **Purpose**: [Component purpose] - **Implementation approach**: [Implementation details] - **Key classes/modules**: [List with descriptions] - **Dependencies**: [Internal and external dependencies] - **Special considerations**: [Important notes] ### Key Files and Components Affected (from tasks.md) [Summary or direct copy of file/component checklists from the original tasks.md for this project. This provides a quick reference to the scope of changes at a component/file level.] ### Algorithms and Complex Logic [Documentation of key algorithms and complex business logic] ### Third-Party Integrations [Details of all third-party integrations including APIs and libraries] ### Configuration Parameters [Complete listing of all configuration parameters and their purpose] ### Build and Packaging Details [Documentation of build process, packaging, and artifacts] ``` ### 4. API Documentation ```markdown ## API Documentation ### API Overview [High-level overview of all APIs (internal and external)] ### API Endpoints - **Endpoint 1**: - **URL/Path**: [Endpoint URL or path] - **Method**: [HTTP method] - **Purpose**: [Purpose of the endpoint] - **Request Format**: [Request format with examples] - **Response Format**: [Response format with examples] - **Error Codes**: [Possible error codes and meanings] - **Security**: [Security considerations] - **Rate Limits**: [Any rate limits] - **Notes**: [Additional notes] - **Endpoint 2**: - **URL/Path**: [Endpoint URL or path] - **Method**: [HTTP method] - **Purpose**: [Purpose of the endpoint] - **Request Format**: [Request format with examples] - **Response Format**: [Response format with examples] - **Error Codes**: [Possible error codes and meanings] - **Security**: [Security considerations] - **Rate Limits**: [Any rate limits] - **Notes**: [Additional notes] ### API Authentication [Authentication methods and implementation details] ### API Versioning Strategy [Versioning approach and migration strategy] ### SDK or Client Libraries [Available SDKs or client libraries with usage examples] ``` ### 5. Data Model and Schema Documentation ```markdown ## Data Model and Schema Documentation ### Data Model Overview [High-level overview of the data model with entity relationship diagrams] ### Database Schema [Detailed database schema with tables, columns, and relationships] ### Data Dictionary [Comprehensive data dictionary with all entities and attributes] ### Data Validation Rules [Data validation rules and enforcement mechanisms] ### Data Migration Procedures [Procedures for data migration and version management] ### Data Archiving Strategy [Strategy for data archiving and retention] ``` ### 6. Security Documentation ```markdown ## Security Documentation ### Security Architecture [Overview of security architecture and design principles] ### Authentication and Authorization [Detailed implementation of authentication and authorization] ### Data Protection Measures [Measures implemented to protect sensitive data] ### Security Controls [Technical and procedural security controls] ### Vulnerability Management [Approach to vulnerability management and patching] ### Security Testing Results [Summary of security testing and assessments] ### Compliance Considerations [Regulatory and compliance considerations addressed] ``` ### 7. Testing Documentation ```markdown ## Testing Documentation ### Test Strategy [Overall testing strategy and approach] ### Test Cases [Catalog of test cases with expected results] ### Automated Tests [Documentation of automated tests and frameworks] ### Performance Test Results [Results of performance testing with benchmarks] ### Security Test Results [Results of security testing with findings] ### User Acceptance Testing [UAT approach, scenarios, and results] ### Known Issues and Limitations [Documentation of known issues and system limitations] ``` ### 8. Deployment Documentation ```markdown ## Deployment Documentation ### Deployment Architecture [Detailed deployment architecture with diagrams] ### Environment Configuration [Configuration details for all environments] ### Deployment Procedures [Step-by-step deployment procedures] ### Configuration Management [Configuration management approach and tools] ### Release Management [Release management process and procedures] ### Rollback Procedures [Procedures for rolling back deployments] ### Monitoring and Alerting [Monitoring setup, metrics, and alerting configuration] ``` ### 9. Operational Documentation ```markdown ## Operational Documentation ### Operating Procedures [Day-to-day operational procedures] ### Maintenance Tasks [Routine maintenance tasks and schedules] ### Troubleshooting Guide [Guide for troubleshooting common issues] ### Backup and Recovery [Backup and recovery procedures] ### Disaster Recovery [Disaster recovery plan and procedures] ### Performance Tuning [Performance tuning guidelines and procedures] ### SLAs and Metrics [Service level agreements and key performance metrics] ``` ### 10. Knowledge Transfer Documentation ```markdown ## Knowledge Transfer Documentation ### System Overview for New Team Members [Concise system overview for onboarding] ### Key Concepts and Terminology [Glossary of key concepts and terminology] ### Common Tasks and Procedures [Guide to common tasks and procedures] ### Frequently Asked Questions [FAQs for system users and maintainers] ### Training Materials [Training materials for different roles] ### Support Escalation Process [Process for escalating support issues] ### Further Reading and Resources [Additional resources and documentation] ``` ### 11. Project History and Learnings ```markdown ## Project History and Learnings ### Project Timeline [Summary of the project timeline and key milestones] ### Key Decisions and Rationale [Record of key decisions and their rationale] ### Challenges and Solutions [Documentation of challenges faced and how they were addressed] ### Lessons Learned [Key lessons learned that might benefit future projects] ### Performance Against Objectives [Assessment of performance against original objectives] ### Future Enhancements [Potential future enhancements and extensions] ``` ## 📋 ARCHIVING PROCESS ### 1. Preparation ```mermaid flowchart TD classDef step fill:#f9d77e,stroke:#d9b95c,color:#000 classDef artifact fill:#f4b8c4,stroke:#d498a4,color:#000 Start([Begin Archive Preparation]) --> Template[Load Archive Template] Template --> Review[Review Project Documentation] Review --> Identify[Identify All Artifacts] Identify --> Gather[Gather All Materials] Gather --> Organize[Organize Materials] Organize --> Plan[Create Archiving Plan] Plan --> Resources[Allocate Resources] Resources --> Complete([Preparation Complete]) Template -.-> AT((Archive Template)) Review -.-> ProjDocs((Project Documentation)) Identify -.-> ArtList((Artifact List)) Plan -.-> ArchPlan((Archiving Plan)) class Start,Complete milestone class Template,Review,Identify,Gather,Organize,Plan,Resources step class AT,ProjDocs,ArtList,ArchPlan artifact ``` **Key Preparation Steps:** 1. Load the comprehensive archive template 2. Review all project documentation including reflection document 3. Identify all artifacts to be archived 4. Gather all materials from various sources 5. Organize materials according to the archive structure 6. Create a detailed archiving plan 7. Allocate resources for the archiving process ### 2. Documentation Creation ```mermaid flowchart TD classDef step fill:#f9d77e,stroke:#d9b95c,color:#000 classDef artifact fill:#f4b8c4,stroke:#d498a4,color:#000 Start([Begin Documentation Creation]) --> System[Create System Documentation] System --> Req[Create Requirements and Design Documentation] Req --> Impl[Create Implementation Documentation] Impl --> API[Create API Documentation] API --> Data[Create Data Model Documentation] Data --> Security[Create Security Documentation] Security --> Test[Create Testing Documentation] Test --> Deploy[Create Deployment Documentation] Deploy --> Ops[Create Operational Documentation] Ops --> Knowledge[Create Knowledge Transfer Documentation] Knowledge --> History[Create Project History Documentation] History --> Review[Review All Documentation] Review --> Complete([Documentation Creation Complete]) System -.-> SysDoc((System Documentation)) Req -.-> ReqDoc((Requirements Documentation)) Impl -.-> ImplDoc((Implementation Documentation)) API -.-> APIDoc((API Documentation)) Data -.-> DataDoc((Data Model Documentation)) Security -.-> SecDoc((Security Documentation)) Test -.-> TestDoc((Testing Documentation)) Deploy -.-> DeployDoc((Deployment Documentation)) Ops -.-> OpsDoc((Operational Documentation)) Knowledge -.-> KnowDoc((Knowledge Transfer Documentation)) History -.-> HistDoc((Project History Documentation)) class Start,Complete milestone class System,Req,Impl,API,Data,Security,Test,Deploy,Ops,Knowledge,History,Review step class SysDoc,ReqDoc,ImplDoc,APIDoc,DataDoc,SecDoc,TestDoc,DeployDoc,OpsDoc,KnowDoc,HistDoc artifact ``` **Key Documentation Steps:** 1. Create comprehensive system documentation 2. Document requirements and design decisions 3. Document implementation details for all components 4. Create complete API documentation 5. Document data models and schemas 6. Document security measures and controls 7. Create thorough testing documentation 8. Document deployment procedures 9. Create operational documentation 10. Prepare knowledge transfer documentation 11. Document project history and learnings 12. Review all documentation for completeness and accuracy ### 3. Archiving and Integration ```mermaid flowchart TD classDef step fill:#f9d77e,stroke:#d9b95c,color:#000 classDef artifact fill:#f4b8c4,stroke:#d498a4,color:#000 classDef verification fill:#c5e8b7,stroke:#a5c897,color:#000 Start([Begin Archiving and Integration]) --> Consolidate[Consolidate All Documentation] Consolidate --> CrossRef[Create Cross-Reference Index] CrossRef --> Version[Version All Documentation] Version --> Archive[Archive in Repository] Archive --> UpdateMB[Update Memory Bank] UpdateMB --> AccessControl[Establish Access Controls] AccessControl --> Announce[Announce Availability] Announce --> Verification{Archiving Verification} Verification -->|Pass| Complete([Archiving Complete]) Verification -->|Fail| Revise[Revise Archiving] Revise --> Verification Consolidate -.-> AllDocs((Consolidated Documentation)) CrossRef -.-> Index((Cross-Reference Index)) Archive -.-> Repo((Archive Repository)) UpdateMB -.-> MB((Updated Memory Bank)) class Start,Complete milestone class Consolidate,CrossRef,Version,Archive,UpdateMB,AccessControl,Announce,Revise step class Verification verification class AllDocs,Index,Repo,MB artifact ``` **Key Archiving Steps:** 1. Consolidate all documentation into a cohesive package 2. Create a cross-reference index linking all documentation 3. Version all documentation appropriately 4. Archive in the designated repository 5. Update Memory Bank with relevant information 6. Establish appropriate access controls 7. Announce availability to relevant stakeholders 8. Verify archiving completeness and accessibility ## 📋 MEMORY BANK INTEGRATION ```mermaid flowchart TD classDef memfile fill:#f4b8c4,stroke:#d498a4,color:#000 classDef process fill:#f9d77e,stroke:#d9b95c,color:#000 Archiving[Comprehensive Archiving] --> PB[projectbrief.md] Archiving --> PC[productContext.md] Archiving --> AC[activeContext.md] Archiving --> SP[systemPatterns.md] Archiving --> TC[techContext.md] Archiving --> P[progress.md] PB & PC & AC & SP & TC & P --> MBI[Memory Bank Integration] MBI --> Next[Repository of Knowledge] class PB,PC,AC,SP,TC,P memfile class Archiving,MBI,Next process ``` ### Memory Bank Updates Specific updates to make to Memory Bank files: 1. **projectbrief.md** - Update with final system description - Document completion status - Include links to archived documentation 2. **productContext.md** - Update with final business context - Document business value delivered - Include links to requirements documentation 3. **activeContext.md** - Update with system status (completed) - Document handover information - Include links to operational documentation 4. **systemPatterns.md** - Update with final architecture patterns - Document successful implementation patterns - Include links to architecture documentation 5. **techContext.md** - Update with final technology stack - Document integration points - Include links to technical documentation 6. **progress.md** - Update with final project status - Document completion metrics - Include links to project history documentation ## 📋 ARCHIVING VERIFICATION CHECKLIST ``` ✓ ARCHIVING VERIFICATION CHECKLIST System Documentation - System overview complete? [YES/NO] - Architecture documented with diagrams? [YES/NO] - Key components documented? [YES/NO] - Integration points documented? [YES/NO] Requirements and Design - Business requirements documented? [YES/NO] - Functional requirements documented? [YES/NO] - Architecture decisions documented? [YES/NO] - Design patterns documented? [YES/NO] Implementation - Component implementation details documented? [YES/NO] - Key algorithms documented? [YES/NO] - Third-party integrations documented? [YES/NO] - Configuration parameters documented? [YES/NO] API Documentation - API endpoints documented? [YES/NO] - Request/response formats documented? [YES/NO] - Authentication documented? [YES/NO] - Error handling documented? [YES/NO] Data Documentation - Data model documented? [YES/NO] - Database schema documented? [YES/NO] - Data dictionary provided? [YES/NO] - Data validation rules documented? [YES/NO] Security Documentation - Security architecture documented? [YES/NO] - Authentication/authorization documented? [YES/NO] - Data protection measures documented? [YES/NO] - Security testing results documented? [YES/NO] Testing Documentation - Test strategy documented? [YES/NO] - Test cases documented? [YES/NO] - Test results documented? [YES/NO] - Known issues documented? [YES/NO] Deployment Documentation - Deployment architecture documented? [YES/NO] - Environment configurations documented? [YES/NO] - Deployment procedures documented? [YES/NO] - Rollback procedures documented? [YES/NO] Operational Documentation - Operating procedures documented? [YES/NO] - Troubleshooting guide provided? [YES/NO] - Backup and recovery documented? [YES/NO] - Monitoring configuration documented? [YES/NO] Knowledge Transfer - Onboarding overview provided? [YES/NO] - Key concepts documented? [YES/NO] - Common tasks documented? [YES/NO] - FAQs provided? [YES/NO] Project History - Project timeline documented? [YES/NO] - Key decisions documented? [YES/NO] - Lessons learned documented? [YES/NO] - Future enhancements suggested? [YES/NO] Memory Bank Integration - All Memory Bank files updated? [YES/NO] - Cross-references created? [YES/NO] - Documentation properly versioned? [YES/NO] - Archive repository established? [YES/NO] ``` ## 📋 MINIMAL MODE ARCHIVING FORMAT For situations requiring a more compact archiving approach: ```markdown ## Level 4 Task Archive: [System Name] ### System Summary - **Purpose**: [Brief description of system purpose] - **Key Components**: [List of key components] - **Architecture**: [Brief architecture description with diagram] ### Implementation Summary - **Technology Stack**: [Key technologies used] - **Key Modules**: [Brief description of important modules] - **Integration Points**: [List of major integration points] ### Critical Documentation - **API Documentation**: [Link or brief summary] - **Data Model**: [Link or brief description] - **Deployment Configuration**: [Link or brief description] - **Security Measures**: [Link or brief summary] ### Operational Information - **Deployment Procedure**: [Link or brief description] - **Key Configuration Parameters**: [List of important parameters] - **Monitoring Setup**: [Brief monitoring details] - **Common Issues**: [List of common issues with solutions] ### Repository Information - **Code Repository**: [Link to repository] - **Documentation Repository**: [Link to documentation] - **Build Artifacts**: [Link to build artifacts] ### Knowledge Transfer Summary - **Key Contacts**: [List of key people with knowledge] - **Critical Knowledge Areas**: [Areas requiring special expertise] - **Training Resources**: [Links to training materials] ### Memory Bank Links - [Links to updated Memory Bank files] ``` ## 🚨 ARCHIVING ENFORCEMENT PRINCIPLE ``` ┌─────────────────────────────────────────────────────┐ │ COMPREHENSIVE ARCHIVING IS MANDATORY for Level 4 │ │ tasks. No complex system is considered complete │ │ until comprehensive archiving is finished and │ │ verified. │ └─────────────────────────────────────────────────────┘ ```

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Angry-Robot-Deals/ace-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server