Entropyk/_bmad/bmb/workflows/agent/steps-e/e-04-sidecar-metadata.md
Sepehr 1fdfefe631 Initial commit: BMAD framework + Story 1.1 Component Trait Definition
Features:
- BMAD (Build Modular AI-driven Development) framework setup
- BMM, BMB, CIS, Core modules configured
- Story 1.1: Component trait with error handling
- Workspace Cargo.toml with components crate
- 31 tests passing (19 unit + 12 doc tests)

Technical:
- Component trait with compute_residuals, jacobian_entries, n_equations
- ComponentError enum with thiserror
- JacobianBuilder for sparse matrix construction
- Object-safe trait supporting Box<dyn Component>
- Comprehensive documentation and examples
2026-02-14 13:54:04 +01:00

4.0 KiB

name description nextStepFile editPlan agentMetadata agentTypesDoc advancedElicitationTask partyModeWorkflow
e-04-sidecar-metadata Review and plan metadata edits ./e-05-persona.md {bmb_creations_output_folder}/edit-plan-{agent-name}.md ../data/agent-metadata.md ../data/understanding-agent-types.md {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml {project-root}/_bmad/core/workflows/party-mode/workflow.md

Edit Step 4: Sidecar and Metadata

STEP GOAL:

Review the agent's hasSidecar decision and metadata, and plan any changes. If edits involve sidecar conversion, identify the implications.

MANDATORY EXECUTION RULES:

  • 📖 CRITICAL: Read the complete step file before taking any action
  • 🔄 CRITICAL: Load agentMetadata and agentTypesDoc first
  • YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config {communication_language}

Step-Specific Rules:

  • 🎯 Load reference documents before discussing edits
  • 📊 Document sidecar conversion requirements if applicable
  • 💬 Focus on metadata that user wants to change

EXECUTION PROTOCOLS:

  • 🎯 Load agentMetadata.md and agentTypesDoc.md
  • 📊 Review current metadata from editPlan
  • 💾 Document planned metadata changes
  • 🚫 FORBIDDEN to proceed without documenting changes

MANDATORY SEQUENCE

CRITICAL: Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.

1. Load Reference Documents

Read {agentMetadata} and {agentTypesDoc} to understand validation rules and sidecar implications.

2. Review Current Metadata

From {editPlan}, display current:

  • hasSidecar (true/false)
  • All metadata fields: id, name, title, icon, module

3. Discuss Metadata Edits

If user wants metadata changes:

For sidecar conversion:

  • "Converting from hasSidecar: {current} to {target}"
  • Explain implications:
    • false → true: Need to create sidecar folder, add critical_actions with sidecar file loading
    • true → false: Remove sidecar fields; if critical_actions only has sidecar references, remove section; otherwise keep non-sidecar critical_actions
  • Update editPlan with conversion

For metadata field changes:

  • id: kebab-case requirements
  • name: display name conventions
  • title: function description format
  • icon: emoji/symbol
  • module: path format

4. Document to Edit Plan

Append to {editPlan}:

metadataEdits:
  sidecarConversion:
    from: {current-hasSidecar}
    to: {target-hasSidecar}
    rationale: {explanation}
  fieldChanges:
    - field: {field-name}
      from: {current-value}
      to: {target-value}

5. Present MENU OPTIONS

Display: "Select an Option: [A] Advanced Elicitation [P] Party Mode [C] Continue to Persona"

Menu Handling Logic:

  • IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu
  • IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu
  • IF C: Save to {editPlan}, then only then load, read entire file, then execute {nextStepFile}
  • IF Any other comments or queries: help user respond then Redisplay Menu Options

EXECUTION RULES:

  • ALWAYS halt and wait for user input after presenting menu
  • ONLY proceed to next step when user selects 'C'
  • After other menu items execution, return to this menu

CRITICAL STEP COMPLETION NOTE

ONLY WHEN [C continue option] is selected and [metadata changes documented], will you then load and read fully {nextStepFile} to execute and begin persona planning.


🚨 SYSTEM SUCCESS/FAILURE METRICS

SUCCESS:

  • Reference documents loaded
  • Metadata changes discussed and documented
  • Sidecar conversion implications understood
  • Edit plan updated

SYSTEM FAILURE:

  • Proceeded without loading reference documents
  • Sidecar conversion without understanding implications
  • Changes not documented to edit plan

Master Rule: Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.