create-byan-agent 2.18.0 → 2.19.0

package/install/templates/_byan/workflow/simple/agent/steps-c/step-07c-build-module.md

@@ -0,0 +1,258 @@
+---
+name: 'step-06-build-module'
+description: 'Generate Module agent YAML from plan'
+
+# File References
+nextStepFile: './step-08-celebrate.md'
+agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md'
+agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}/'
+agentYamlOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml'
+
+# Template and Architecture (use expert as baseline)
+expertTemplate: ../templates/expert-agent-template/expert-agent.template.md
+expertArch: ../data/expert-agent-architecture.md
+agentCompilation: ../data/agent-compilation.md
+criticalActions: ../data/critical-actions.md
+
+# Task References
+advancedElicitationTask: '{project-root}/_byan/workflow/simple/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_byan/workflow/simple/party-mode/workflow.md'
+---
+
+# STEP GOAL
+Assemble the Module agent YAML file from the approved plan, using the expert agent template as the baseline architecture and adding module-specific workflow integration paths and sidecar configuration.
+
+# MANDATORY EXECUTION RULES
+
+1. **TEMPLATE BASELINE**: Module agents MUST use the expert agent template as their structural foundation - do not create custom templates
+
+2. **PLAN ADHERENCE**: Extract content from agentPlan exactly as written - no enhancement, interpretation, or extrapolation
+
+3. **MODULE SPECIFICITY**: Module agents require workflow integration paths and may need sidecar configuration for multi-workflow modules
+
+4. **OUTPUT VALIDATION**: YAML must be valid, complete, and ready for immediate deployment
+
+5. **LANGUAGE PRESERVATION**: Maintain any language choice configured in the plan throughout the YAML
+
+# EXECUTION PROTOCOLS
+
+## PREPARATION PHASE
+
+### 1. Load Expert Template Baseline
+```
+Read: expertTemplate
+Read: expertArch
+Read: agentCompilation
+Read: criticalActions
+```
+
+**Purpose**: Understand the expert agent structure that serves as the Module agent baseline
+
+**Validation**: Confirm expert template has all required sections (name, description, persona, instructions, tools, skills, etc.)
+
+### 2. Load Agent Plan
+```
+Read: agentPlan (using dynamic path)
+```
+
+**Validation**: Plan contains all mandatory sections:
+- Agent identity (name, description)
+- Persona profile
+- Command structure
+- Critical actions
+- Workflow integrations (module-specific)
+- Language choice (if configured)
+
+### 3. Verify Output Directory
+```
+Bash: mkdir -p {agentBuildOutput}
+```
+
+**Purpose**: Ensure output directory exists for the module agent
+
+## ASSEMBLY PHASE
+
+### 4. Assemble Module Agent YAML
+
+**FROM PLAN TO YAML MAPPING:**
+
+| Plan Section | YAML Field | Notes |
+|--------------|------------|-------|
+| Agent Name | `name` | Plan → YAML |
+| Description | `description` | Plan → YAML |
+| Persona | `persona` | Plan → YAML |
+| Instructions | `instructions` | Plan → YAML (verbatim) |
+| Commands | `commands` | Plan → YAML (with handlers) |
+| Critical Actions | `criticalActions` | Plan → YAML (mandatory) |
+| Workflow Paths | `skills` | Module-specific |
+| Sidecar Need | `sidecar` | If multi-workflow |
+
+**MODULE-SPECIAL ENHANCEMENTS:**
+
+```yaml
+# Module agents include workflow integration
+skills:
+  - workflow: "{project-root}/_byan/{module-id}/workflows/{workflow-name}/workflow.md"
+    description: "From plan workflow list"
+  - workflow: "{project-root}/_byan/{module-id}/workflows/{another-workflow}/workflow.md"
+    description: "From plan workflow list"
+
+# Optional: Sidecar for complex modules
+sidecar:
+  enabled: true
+  workflows:
+    - ref: "primary-workflow"
+      type: "primary"
+    - ref: "secondary-workflow"
+      type: "support"
+```
+
+**CRITICAL ACTIONS MAPPING:**
+```
+For each critical action in plan:
+1. Identify matching command in YAML
+2. Add `critical: true` flag
+3. Ensure handler references agent function
+```
+
+### 5. Create Sidecar (If Needed)
+
+**SIDEAR REQUIRED IF:**
+- Module has 3+ workflows
+- Workflows have complex interdependencies
+- Module needs initialization workflow
+
+**SIDECAR STRUCTURE:**
+```yaml
+# {agent-name}.sidecar.yaml
+sidecar:
+  module: "{module-id}"
+  initialization:
+    workflow: "workflow-init"
+    required: true
+  workflows:
+    - name: "workflow-name"
+      path: "workflows/{workflow-name}/workflow.md"
+      type: "primary|support|utility"
+      dependencies: []
+  agent:
+    path: "{agent-name}.agent.yaml"
+```
+
+**IF SIDEAR NOT NEEDED**: Skip this step
+
+### 6. Write Module Agent YAML
+```
+Write: agentYamlOutput (using dynamic path)
+Content: Assembled YAML from step 4
+```
+
+**Validation Checklist:**
+- [ ] All plan fields present in YAML
+- [ ] Workflow paths are valid and correct
+- [ ] Critical actions flagged
+- [ ] Sidecar created (if needed) or skipped (if not)
+- [ ] YAML syntax is valid
+- [ ] Language choice preserved throughout
+
+## COMPLETION PHASE
+
+### 7. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
+
+#### 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: Write agent YAML to {agentBuildOutput}/{agent-name}/{agent-name}.agent.yaml (or appropriate output path), update frontmatter, then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-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
+- User can chat or ask questions - always respond and then end with display again of the menu options
+
+**USER RESPONSE HANDLING:**
+- **Option 1**: Proceed to step-07a-plan-traceability.md with sequential mode
+- **Option 2**: Proceed to step-07a-plan-traceability.md with yolo mode
+- **Invalid input**: Re-ask with options
+
+# CONTEXT BOUNDARIES
+
+**IN SCOPE:**
+- Reading expert template and architecture
+- Loading agent plan
+- Assembling Module agent YAML
+- Creating sidecar (if needed)
+- Writing valid YAML output
+
+**OUT OF SCOPE:**
+- Modifying plan content
+- Creating new template structures
+- Implementing agent code
+- Writing workflow files
+- Testing agent functionality
+
+**DO NOT:**
+- Add commands not in plan
+- Modify persona from plan
+- Create custom template structures
+- Skip critical actions mapping
+- Assume sidecar need - evaluate based on workflow count
+
+# CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion.
+
+**THIS STEP IS COMPLETE WHEN:**
+1. Module agent YAML file exists at agentYamlOutput path
+2. YAML contains all plan content correctly mapped
+3. Module-specific workflow paths are configured
+4. Sidecar is created (if needed) or correctly skipped (if not)
+5. User has chosen review mode (one-at-a-time or YOLO)
+6. Ready to proceed to step-07a-plan-traceability.md
+
+**STOP BEFORE:**
+- Writing workflow implementations
+- Creating agent code files
+- Testing agent functionality
+- Deploying to active system
+
+# SUCCESS METRICS
+
+**COMPLETION:**
+- [ ] Module agent YAML exists with all required fields
+- [ ] All plan content accurately mapped to YAML
+- [ ] Workflow integration paths configured correctly
+- [ ] Critical actions properly flagged
+- [ ] Sidecar created or correctly skipped
+- [ ] YAML syntax is valid
+- [ ] User confirms review mode choice
+- [ ] Transitions to step-07a-plan-traceability.md
+
+**VALIDATION:**
+- Plan-to-YAML mapping: 100% accuracy
+- Workflow paths: All valid and correct
+- Critical actions: All present and flagged
+- Sidecar decision: Correctly evaluated
+- Language choice: Preserved throughout
+
+# FAILURE MODES
+
+**IF PLAN MISSING CONTENT:**
+→ Return to step-02-discover.md to complete plan
+
+**IF EXPERT TEMPLATE MISSING:**
+→ Raise error - template is mandatory baseline
+
+**IF YAML SYNTAX ERROR:**
+→ Fix and retry write operation
+
+**IF WORKFLOW PATHS INVALID:**
+→ Flag for review in traceability step
+
+**IF USER ASKS FOR MODIFICATIONS:**
+→ Return to appropriate planning step (03-persona, 04-commands, or 05-name)

package/install/templates/_byan/workflow/simple/agent/steps-c/step-08-celebrate.md

@@ -0,0 +1,249 @@
+---
+name: 'step-08-celebrate'
+description: 'Celebrate completion and guide next steps for using the agent'
+
+# File References
+thisStepFile: ./step-08-celebrate.md
+workflowFile: ../workflow.md
+outputFile: {bmb_creations_output_folder}/agent-completion-{agent_name}.md
+
+# Task References
+advancedElicitationTask: '{project-root}/_byan/workflow/simple/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_byan/workflow/simple/party-mode/workflow.md'
+installationDocs: 'https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/modules/bmb-bmad-builder/custom-content-installation.md#standalone-content-agents-workflows-tasks-tools-templates-prompts'
+validationWorkflow: '{project-root}/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md'
+---
+
+# Step 8: Celebration and Installation Guidance
+
+## STEP GOAL:
+
+Celebrate the successful agent creation, recap the agent's capabilities, provide installation guidance, and mark workflow completion.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a celebration coordinator who guides users through agent installation and activation
+- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring installation expertise, user brings their excitement about their new agent, together we ensure successful agent installation and usage
+- ✅ Maintain collaborative celebratory tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on celebrating completion and guiding installation
+- 🚫 FORBIDDEN to end without marking workflow completion in frontmatter
+- 💬 Approach: Celebrate enthusiastically while providing practical installation guidance
+- 📋 Ensure user understands installation steps and agent capabilities
+- 🔗 Always provide installation documentation link for reference
+
+## EXECUTION PROTOCOLS:
+
+- 🎉 Celebrate agent creation achievement enthusiastically
+- 💾 Mark workflow completion in frontmatter
+- 📖 Provide clear installation guidance
+- 🔗 Share installation documentation link
+- 🚫 FORBIDDEN to end workflow without proper completion marking
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete, validated, and built agent from previous steps
+- Focus: Celebration, installation guidance, and workflow completion
+- Limits: No agent modifications, only installation guidance and celebration
+- Dependencies: Complete agent ready for installation
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. (Do not deviate, skip, or optimize)
+
+### 1. Grand Celebration
+
+Present enthusiastic celebration:
+
+"🎉 Congratulations! We did it! {agent_name} is complete and ready to help users with {agent_purpose}!"
+
+**Journey Celebration:**
+"Let's celebrate what we accomplished together:
+
+- Started with an idea and discovered its true purpose
+- Crafted a unique personality with the four-field persona system
+- Built powerful capabilities and commands
+- Established a perfect name and identity
+- Created complete YAML configuration
+- Validated quality and prepared for deployment"
+
+### 2. Agent Capabilities Showcase
+
+**Agent Introduction:**
+"Meet {agent_name} - your {agent_type} agent ready to {agent_purpose}!"
+
+**Key Features:**
+"✨ **What makes {agent_name} special:**
+
+- {unique_personality_trait} personality that {communication_style_benefit}
+- Expert in {domain_expertise} with {specialized_knowledge}
+- {number_commands} powerful commands including {featured_command}
+- Ready to help with {specific_use_cases}"
+
+### 3. Activation Guidance
+
+**Getting Started:**
+"Here's how to start using {agent_name}:"
+
+**Activation Steps:**
+
+1. **Locate your agent files:** `{agent_file_location}`
+2. **If compiled:** Use the compiled version at `{compiled_location}`
+3. **For customization:** Edit the customization file at `{customization_location}`
+4. **First interaction:** Start by asking for help to see available commands
+
+**First Conversation Suggestions:**
+"Try starting with:
+
+- 'Hi {agent_name}, what can you help me with?'
+- 'Tell me about your capabilities'
+- 'Help me with [specific task related to agent purpose]'"
+
+### 4. Installation Guidance
+
+**Making Your Agent Installable:**
+"Now that {agent_name} is complete, let's get it installed and ready to use!"
+
+**Installation Overview:**
+"To make your agent installable and sharable, you'll need to package it as a standalone BMAD content module. Here's what you need to know:"
+
+**Key Steps:**
+1. **Create a module folder:** Name it something descriptive (e.g., `my-custom-stuff`)
+2. **Add module.yaml:** Include a `module.yaml` file with `unitary: true`
+3. **Structure your agent:** Place your agent file in `agents/{agent-name}/{agent-name}.agent.yaml`
+4. **Include sidecar (if Expert):** For Expert agents, include the `_memory/{sidecar-folder}/` structure
+
+**Module Structure Example:**
+```
+my-custom-stuff/
+├── module.yaml          # Contains: unitary: true
+├── agents/              # Custom agents go here
+│   └── {agent-name}/
+│       ├── {agent-name}.agent.yaml
+│       └── _memory/              # Expert agents only
+│           └── {sidecar-folder}/
+│               ├── memories.md
+│               └── instructions.md
+└── workflows/           # Optional: standalone custom workflows
+    └── {workflow-name}/
+        └── workflow.md
+```
+
+**Note:** Your custom module can contain agents, workflows, or both. The `agents/` and `workflows/` folders are siblings alongside `module.yaml`.
+
+**Installation Methods:**
+- **New projects:** The BMAD installer will prompt for local custom modules
+- **Existing projects:** Use "Modify BMAD Installation" to add your module
+
+**Full Documentation:**
+"For complete details on packaging, sharing, and installing your custom agent, including all the configuration options and troubleshooting tips, see the official installation guide:"
+
+📖 **[BMAD Custom Content Installation Guide]({installationDocs})**
+
+### 5. Final Documentation
+
+#### Content to Append (if applicable):
+
+```markdown
+## Agent Creation Complete! 🎉
+
+### Agent Summary
+
+- **Name:** {agent_name}
+- **Type:** {agent_type}
+- **Purpose:** {agent_purpose}
+- **Status:** Ready for installation
+
+### File Locations
+
+- **Agent Config:** {agent_file_path}
+- **Compiled Version:** {compiled_agent_path}
+- **Customization:** {customization_file_path}
+
+### Installation
+
+Package your agent as a standalone module with `module.yaml` containing `unitary: true`.
+See: {installationDocs}
+
+### Quick Start
+
+1. Create a module folder
+2. Add module.yaml with `unitary: true`
+3. Place agent in `agents/{agent-name}/` structure
+4. Include sidecar folder for Expert agents
+5. Install via BMAD installer
+```
+
+Save this content to `{outputFile}` for reference.
+
+### 6. Workflow Completion
+
+**Mark Complete:**
+"Agent creation workflow completed successfully! {agent_name} is ready to be installed and used. Amazing work!"
+
+**Final Achievement:**
+"You've successfully created a custom BMAD agent from concept to installation-ready configuration. The journey from idea to deployable agent is complete!"
+
+### 7. Present MENU OPTIONS
+
+Display: "**✅ Agent Build Complete! Select an Option:** [V] Run Validation [S] Skip - Complete Now [A] Advanced Elicitation [P] Party Mode"
+
+#### Menu Handling Logic:
+
+- IF V: "Loading validation phase..." → Save celebration content to {outputFile}, update frontmatter with build completion, then load, read entire file, then execute {validationWorkflow}
+- IF S: "Skipping validation. Completing workflow..." → Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully
+- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu
+- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- User can choose validation (V), skip to complete (S), or use advanced elicitation (A) or party mode (P)
+- After other menu items execution (A/P), return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [S skip option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for installation.
+IF [V validation option] is selected, the validation workflow will be loaded to perform comprehensive validation checks.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Enthusiastic celebration of agent creation achievement
+- Clear installation guidance provided
+- Agent capabilities and value clearly communicated
+- Installation documentation link shared with context
+- Module structure and packaging explained
+- User confidence in agent installation established
+- Workflow properly marked as complete in frontmatter
+- Content properly saved to output file
+- Menu presented with exit option
+
+### ❌ SYSTEM FAILURE:
+
+- Ending without marking workflow completion
+- Not providing clear installation guidance
+- Missing celebration of achievement
+- Not sharing installation documentation link
+- Not ensuring user understands installation steps
+- Failing to update frontmatter completion status
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.