BMAD-METHOD/bmad-agent/memory/memory-integration.md

685 lines
19 KiB
Markdown

# BMAD Memory Integration Methodology
## Overview
This methodology defines how to integrate memory systems with orchestrators, personas, and IDE environments. It provides frameworks for seamless communication, workflow integration, and cross-component coordination while maintaining performance and reliability.
## Orchestrator Integration Framework
### Memory-Orchestrator Communication Patterns
#### Event-Driven Integration
\.```yaml
event_driven_integration:
memory_events:
creation_events:
- memory_created
- memory_validated
- memory_indexed
- memory_relationships_established
modification_events:
- memory_updated
- memory_enhanced
- memory_relationships_changed
- memory_importance_adjusted
access_events:
- memory_accessed
- memory_retrieved
- memory_search_performed
- memory_shared
lifecycle_events:
- memory_archived
- memory_deleted
- memory_consolidated
- memory_migrated
orchestrator_events:
workflow_events:
- workflow_started
- workflow_step_completed
- workflow_paused
- workflow_completed
persona_events:
- persona_activated
- persona_switched
- persona_task_assigned
- persona_collaboration_initiated
context_events:
- context_changed
- context_expanded
- context_focused
- context_reset
\.```
#### Request-Response Integration
\.```yaml
request_response_integration:
memory_requests:
retrieval_requests:
- find_relevant_memories
- get_memory_by_id
- search_memories_by_criteria
- get_related_memories
storage_requests:
- store_new_memory
- update_existing_memory
- create_memory_relationship
- set_memory_importance
analysis_requests:
- analyze_memory_patterns
- assess_memory_quality
- identify_memory_gaps
- recommend_memory_actions
orchestrator_requests:
context_requests:
- get_current_context
- get_workflow_state
- get_active_personas
- get_user_preferences
coordination_requests:
- coordinate_persona_handoff
- synchronize_workflow_state
- manage_resource_allocation
- handle_conflict_resolution
\.```
### Context Synchronization
#### Context State Management
\.```yaml
context_state_management:
context_dimensions:
user_context:
- current_user_identity
- user_preferences
- user_session_state
- user_activity_history
project_context:
- active_project_details
- project_phase_information
- project_team_composition
- project_constraints_and_requirements
workflow_context:
- current_workflow_stage
- workflow_history
- pending_tasks
- workflow_dependencies
technical_context:
- technology_stack
- development_environment
- system_architecture
- performance_constraints
synchronization_strategies:
real_time_sync:
- immediate_context_updates
- event_driven_synchronization
- conflict_resolution_procedures
- consistency_maintenance
batch_sync:
- periodic_context_updates
- bulk_synchronization_operations
- optimization_for_performance
- eventual_consistency_model
on_demand_sync:
- context_synchronization_on_request
- lazy_loading_of_context
- selective_synchronization
- resource_efficient_updates
\.```
#### Context Propagation
\.```yaml
context_propagation:
propagation_mechanisms:
direct_propagation:
- immediate_context_sharing
- synchronous_updates
- guaranteed_consistency
- high_performance_requirements
message_based_propagation:
- asynchronous_context_updates
- message_queue_integration
- eventual_consistency
- scalable_architecture
event_sourcing_propagation:
- event_based_context_reconstruction
- audit_trail_maintenance
- temporal_context_queries
- replay_capability
propagation_scope:
local_propagation:
- within_single_ide_instance
- session_scoped_context
- immediate_consistency
- low_latency_updates
distributed_propagation:
- across_multiple_instances
- team_wide_context_sharing
- eventual_consistency
- conflict_resolution_required
\.```
### Workflow Integration Patterns
#### Memory-Aware Workflows
\.```yaml
memory_aware_workflows:
workflow_memory_integration:
workflow_state_persistence:
- store_workflow_checkpoints
- maintain_workflow_history
- enable_workflow_recovery
- support_workflow_analysis
decision_point_memory:
- capture_decision_rationale
- store_alternative_options
- maintain_decision_context
- enable_decision_review
knowledge_accumulation:
- aggregate_workflow_learnings
- identify_best_practices
- capture_failure_patterns
- build_organizational_knowledge
memory_driven_workflows:
memory_triggered_workflows:
- initiate_workflows_based_on_memory_events
- respond_to_memory_pattern_detection
- automate_memory_maintenance_workflows
- trigger_knowledge_sharing_workflows
memory_guided_workflows:
- use_memory_for_workflow_optimization
- adapt_workflows_based_on_historical_data
- personalize_workflows_using_user_memory
- optimize_workflows_using_performance_memory
\.```
#### Collaborative Workflows
\.```yaml
collaborative_workflows:
multi_persona_coordination:
handoff_procedures:
- transfer_context_between_personas
- maintain_workflow_continuity
- preserve_decision_history
- ensure_knowledge_transfer
parallel_processing:
- coordinate_simultaneous_persona_activities
- manage_shared_memory_access
- resolve_conflicting_updates
- maintain_consistency_across_personas
consensus_building:
- facilitate_multi_persona_decisions
- capture_diverse_perspectives
- resolve_disagreements
- document_consensus_process
team_collaboration:
shared_memory_spaces:
- create_team_accessible_memories
- manage_collaborative_editing
- maintain_version_control
- handle_concurrent_modifications
knowledge_sharing:
- facilitate_knowledge_transfer
- identify_knowledge_gaps
- recommend_knowledge_sources
- track_knowledge_utilization
\.```
## Persona Integration Framework
### Persona-Specific Memory Patterns
#### Architect Persona Integration
\.```yaml
architect_integration:
memory_specialization:
architectural_patterns:
- store_design_patterns
- maintain_pattern_relationships
- track_pattern_effectiveness
- evolve_pattern_library
technical_decisions:
- capture_decision_rationale
- maintain_decision_history
- track_decision_outcomes
- enable_decision_analysis
system_knowledge:
- build_system_understanding
- maintain_component_relationships
- track_system_evolution
- identify_architectural_debt
workflow_integration:
design_workflows:
- integrate_memory_into_design_process
- use_historical_decisions_for_guidance
- leverage_pattern_library_for_solutions
- maintain_design_documentation
review_workflows:
- use_memory_for_architecture_reviews
- compare_with_historical_decisions
- identify_consistency_issues
- recommend_improvements
\.```
#### Product Manager Integration
\.```yaml
product_manager_integration:
memory_specialization:
requirement_tracking:
- maintain_requirement_evolution
- track_stakeholder_feedback
- capture_requirement_rationale
- monitor_requirement_fulfillment
stakeholder_management:
- store_stakeholder_preferences
- track_communication_history
- maintain_relationship_context
- identify_influence_patterns
market_intelligence:
- capture_market_insights
- track_competitive_analysis
- maintain_user_feedback
- monitor_market_trends
workflow_integration:
planning_workflows:
- use_memory_for_product_planning
- leverage_historical_data_for_estimates
- incorporate_stakeholder_feedback
- optimize_feature_prioritization
communication_workflows:
- personalize_stakeholder_communications
- maintain_communication_consistency
- track_communication_effectiveness
- improve_messaging_strategies
\.```
#### V0 UX/UI Architect Integration
\.```yaml
v0_ux_ui_integration:
memory_specialization:
design_patterns:
- maintain_ui_pattern_library
- track_pattern_usage_effectiveness
- evolve_design_system
- capture_user_interaction_patterns
user_research:
- store_user_research_findings
- maintain_user_persona_data
- track_usability_test_results
- capture_accessibility_requirements
component_knowledge:
- maintain_component_specifications
- track_component_performance
- store_component_variations
- capture_component_relationships
workflow_integration:
design_workflows:
- integrate_memory_into_design_process
- use_pattern_library_for_consistency
- leverage_user_research_for_decisions
- maintain_design_documentation
prototyping_workflows:
- use_component_memory_for_rapid_prototyping
- apply_design_patterns_automatically
- incorporate_user_feedback_iteratively
- maintain_prototype_evolution_history
\.```
### Cross-Persona Memory Sharing
#### Shared Knowledge Spaces
\.```yaml
shared_knowledge_spaces:
knowledge_domains:
technical_knowledge:
- shared_technical_patterns
- common_architectural_decisions
- reusable_technical_solutions
- cross_functional_technical_insights
business_knowledge:
- shared_business_requirements
- common_stakeholder_insights
- reusable_business_patterns
- cross_functional_business_understanding
process_knowledge:
- shared_workflow_patterns
- common_process_improvements
- reusable_process_templates
- cross_functional_process_insights
sharing_mechanisms:
automatic_sharing:
- identify_shareable_memories
- apply_sharing_rules
- maintain_sharing_permissions
- track_sharing_effectiveness
manual_sharing:
- enable_explicit_memory_sharing
- provide_sharing_recommendations
- facilitate_knowledge_transfer
- maintain_sharing_audit_trail
\.```
#### Knowledge Transfer Patterns
\.```yaml
knowledge_transfer:
transfer_triggers:
persona_handoff:
- transfer_relevant_context
- share_decision_history
- provide_background_knowledge
- maintain_continuity
collaboration_initiation:
- share_relevant_expertise
- provide_context_background
- establish_common_understanding
- facilitate_effective_collaboration
knowledge_gap_identification:
- identify_missing_knowledge
- recommend_knowledge_sources
- facilitate_knowledge_acquisition
- track_knowledge_transfer_effectiveness
transfer_mechanisms:
contextual_transfer:
- provide_just_in_time_knowledge
- adapt_knowledge_to_context
- filter_relevant_information
- optimize_for_immediate_needs
comprehensive_transfer:
- provide_complete_knowledge_context
- include_historical_background
- share_related_knowledge
- enable_deep_understanding
\.```
## IDE Environment Integration
### Platform-Specific Integration Strategies
#### Claude Code Integration
\.```yaml
claude_code_integration:
conversation_integration:
memory_enhanced_conversations:
- inject_relevant_memories_into_context
- maintain_conversation_continuity
- provide_historical_context
- enable_reference_to_past_discussions
context_aware_responses:
- adapt_responses_based_on_memory
- personalize_interactions_using_history
- provide_consistent_recommendations
- maintain_conversation_coherence
file_system_integration:
memory_file_synchronization:
- sync_memories_with_project_files
- maintain_file_memory_relationships
- track_file_change_impact_on_memory
- enable_file_based_memory_triggers
project_structure_awareness:
- understand_project_organization
- adapt_memory_organization_to_project
- provide_project_specific_memories
- maintain_project_scoped_context
\.```
#### Cursor AI Integration
\.```yaml
cursor_ai_integration:
editor_integration:
code_aware_memory:
- link_memories_to_code_elements
- provide_code_context_in_memories
- track_code_evolution_in_memory
- enable_code_triggered_memory_retrieval
intelligent_suggestions:
- use_memory_for_code_suggestions
- provide_context_aware_completions
- recommend_based_on_historical_patterns
- adapt_suggestions_to_user_preferences
workspace_integration:
workspace_scoped_memory:
- maintain_workspace_specific_memories
- provide_workspace_context_awareness
- enable_cross_file_memory_relationships
- support_workspace_wide_memory_search
project_lifecycle_integration:
- integrate_with_project_events
- maintain_project_memory_lifecycle
- provide_project_phase_specific_memories
- enable_project_evolution_tracking
\.```
#### V0 Integration
\.```yaml
v0_integration:
component_integration:
component_memory_linking:
- link_memories_to_ui_components
- maintain_component_design_history
- track_component_usage_patterns
- enable_component_based_memory_retrieval
design_system_integration:
- integrate_memory_with_design_system
- maintain_design_token_memories
- track_design_system_evolution
- provide_design_consistency_guidance
user_interaction_integration:
interaction_pattern_memory:
- capture_user_interaction_patterns
- maintain_usability_insights
- track_user_preference_evolution
- enable_personalized_design_recommendations
feedback_integration:
- capture_user_feedback_in_memory
- maintain_feedback_context
- track_feedback_resolution
- enable_feedback_driven_improvements
\.```
#### JetBrains Integration
\.```yaml
jetbrains_integration:
ide_event_integration:
ide_aware_memory:
- integrate_with_ide_events
- maintain_ide_context_awareness
- provide_ide_specific_memories
- enable_ide_triggered_memory_operations
project_model_integration:
- integrate_with_jetbrains_project_model
- maintain_project_structure_awareness
- provide_module_specific_memories
- enable_dependency_aware_memory_retrieval
plugin_ecosystem_integration:
plugin_memory_coordination:
- coordinate_memory_across_plugins
- maintain_plugin_specific_memories
- enable_cross_plugin_memory_sharing
- provide_plugin_ecosystem_awareness
tool_integration:
- integrate_with_development_tools
- maintain_tool_specific_memories
- provide_tool_usage_insights
- enable_tool_optimization_recommendations
\.```
### Cross-Platform Integration
#### Universal Integration Patterns
\.```yaml
universal_integration:
common_integration_interfaces:
memory_api_standardization:
- define_common_memory_operations
- standardize_memory_data_formats
- provide_consistent_query_interfaces
- enable_cross_platform_compatibility
event_system_standardization:
- define_common_event_formats
- standardize_event_handling_patterns
- provide_consistent_event_interfaces
- enable_cross_platform_event_coordination
platform_abstraction:
storage_abstraction:
- abstract_platform_specific_storage
- provide_unified_storage_interface
- enable_storage_portability
- maintain_platform_optimization
ui_abstraction:
- abstract_platform_specific_ui
- provide_unified_ui_interface
- enable_ui_portability
- maintain_platform_native_experience
\.```
#### Migration and Portability
\.```yaml
migration_portability:
data_migration:
cross_platform_migration:
- enable_memory_export_import
- maintain_data_integrity_during_migration
- provide_migration_validation
- support_incremental_migration
format_conversion:
- convert_between_platform_formats
- maintain_semantic_equivalence
- preserve_relationship_integrity
- enable_bidirectional_conversion
configuration_portability:
settings_migration:
- migrate_memory_configurations
- adapt_settings_to_target_platform
- maintain_user_preferences
- provide_configuration_validation
workflow_portability:
- migrate_workflow_configurations
- adapt_workflows_to_target_platform
- maintain_workflow_effectiveness
- provide_workflow_optimization
\.```
## Performance and Scalability Integration
### Performance Optimization Patterns
#### Memory-Orchestrator Performance
\.```yaml
memory_orchestrator_performance:
communication_optimization:
batching_strategies:
- batch_memory_operations
- optimize_communication_overhead
- reduce_network_latency
- improve_throughput
caching_strategies:
- cache_frequently_accessed_memories
- implement_intelligent_prefetching
- optimize_cache_hit_ratios
- reduce_memory_access_latency
asynchronous_processing:
- implement_non_blocking_operations
- enable_parallel_processing
- optimize_resource_utilization
- improve_system_responsiveness
\.```
#### Scalability Patterns
\.```yaml
scalability_patterns:
horizontal_scaling:
distributed_memory:
- distribute_memory_across_nodes
- implement_consistent_hashing
- enable_automatic_rebalancing
- maintain_data_locality
load_balancing:
- distribute_memory_operations
- implement_intelligent_routing
- optimize_resource_utilization
- maintain_system_performance
vertical_scaling:
resource_optimization:
- optimize_memory_usage
- implement_efficient_algorithms
- reduce_computational_complexity
- improve_single_node_performance
capacity_planning:
- monitor_resource_utilization
- predict_capacity_requirements
- plan_resource_allocation
- optimize_cost_effectiveness
\.```
This methodology provides comprehensive guidance for integrating memory systems with orchestrators, personas, and IDE environments while maintaining performance, reliability, and user experience across different platforms.