bmad-method 6.0.0-alpha.0 → 6.0.0-alpha.2

package/bmad/bmb/workflows/edit-agent/instructions.md

@@ -0,0 +1,290 @@
+# Edit Agent - Agent Editor Instructions
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/edit-agent/workflow.yaml</critical>
+<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
+<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
+<critical>Communicate all responses in {communication_language}</critical>
+
+<workflow>
+
+<step n="1" goal="Load and deeply understand the target agent">
+<ask>What is the path to the agent you want to edit?</ask>
+
+<action>Load the agent file from the provided path</action>
+<action>Load ALL agent documentation to inform understanding:
+
+- Agent types guide: {agent_types}
+- Agent architecture: {agent_architecture}
+- Command patterns: {agent_commands}
+- Communication styles: {communication_styles}
+- Workflow execution engine: {workflow_execution_engine}
+  </action>
+
+<action>Analyze the agent structure thoroughly:
+
+- Parse persona (role, identity, communication_style, principles)
+- Understand activation flow and steps
+- Map menu items and their workflows
+- Identify configuration dependencies
+- Assess agent type (full, hybrid, standalone)
+- Check workflow references for validity
+- Evaluate against best practices from loaded guides
+  </action>
+
+<action>Reflect understanding back to {user_name}:
+
+Present a warm, conversational summary adapted to the agent's complexity:
+
+- What this agent does (its role and purpose)
+- How it's structured (type, menu items, workflows)
+- What you notice (strengths, potential improvements, issues)
+- Your initial assessment of its health
+
+Be conversational, not clinical. Help {user_name} see their agent through your eyes.
+</action>
+
+<ask>Does this match your understanding of what this agent should do?</ask>
+<template-output>agent_understanding</template-output>
+</step>
+
+<step n="2" goal="Discover improvement goals collaboratively">
+<critical>Understand WHAT the user wants to improve and WHY before diving into edits</critical>
+
+<action>Engage in collaborative discovery:
+
+Ask open-ended questions to understand their goals:
+
+- What prompted you to want to edit this agent?
+- What isn't working the way you'd like?
+- Are there specific behaviors you want to change?
+- Is there functionality you want to add or remove?
+- How do users interact with this agent? What feedback have they given?
+
+Listen for clues about:
+
+- Functional issues (broken references, missing workflows)
+- User experience issues (confusing menu, unclear communication)
+- Performance issues (too slow, too verbose, not adaptive enough)
+- Maintenance issues (hard to update, bloated, inconsistent)
+- Integration issues (doesn't work well with other agents/workflows)
+  </action>
+
+<action>Based on their responses and your analysis from step 1, identify improvement opportunities:
+
+Organize by priority and user goals:
+
+- CRITICAL issues blocking functionality
+- IMPORTANT improvements enhancing user experience
+- NICE-TO-HAVE enhancements for polish
+
+Present these conversationally, explaining WHY each matters and HOW it would help.
+</action>
+
+<action>Collaborate on priorities:
+
+Don't just list options - discuss them:
+
+- "I noticed {{issue}} - this could cause {{problem}}. Does this concern you?"
+- "The agent could be more {{improvement}} which would help when {{use_case}}. Worth exploring?"
+- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?"
+
+Let the conversation flow naturally. Build a shared vision of what "better" looks like.
+</action>
+
+<template-output>improvement_goals</template-output>
+</step>
+
+<step n="3" goal="Facilitate improvements collaboratively" repeat="until-user-satisfied">
+<critical>Work iteratively - improve, review, refine. Never dump all changes at once.</critical>
+
+<action>For each improvement area, facilitate collaboratively:
+
+1. **Explain the current state and why it matters**
+   - Show relevant sections of the agent
+   - Explain how it works now and implications
+   - Connect to user's goals from step 2
+
+2. **Propose improvements with rationale**
+   - Suggest specific changes that align with best practices
+   - Explain WHY each change helps
+   - Provide examples from the loaded guides when helpful
+   - Show before/after comparisons for clarity
+
+3. **Collaborate on the approach**
+   - Ask if the proposed change addresses their need
+   - Invite modifications or alternative approaches
+   - Explain tradeoffs when relevant
+   - Adapt based on their feedback
+
+4. **Apply changes iteratively**
+   - Make one focused improvement at a time
+   - Show the updated section
+   - Confirm it meets their expectation
+   - Move to next improvement or refine current one
+     </action>
+
+<action>Common improvement patterns to facilitate:
+
+**If fixing broken references:**
+
+- Identify all broken paths
+- Explain what each reference should point to
+- Verify new paths exist before updating
+- Update and confirm working
+
+**If refining persona/communication:**
+
+- Review current persona definition
+- Discuss desired communication style with examples
+- Explore communication styles guide for patterns
+- Refine language to match intent
+- Test tone with example interactions
+
+**If updating activation:**
+
+- Walk through current activation flow
+- Identify bottlenecks or confusion points
+- Propose streamlined flow
+- Ensure config loading works correctly
+- Verify all session variables are set
+
+**If managing menu items:**
+
+- Review current menu organization
+- Discuss if structure serves user mental model
+- Add/remove/reorganize as needed
+- Ensure all workflow references are valid
+- Update triggers to be intuitive
+
+**If enhancing menu handlers:**
+
+- Explain current handler logic
+- Identify where handlers could be smarter
+- Propose enhanced logic based on agent architecture patterns
+- Ensure handlers properly invoke workflows
+
+**If optimizing agent type:**
+
+- Discuss whether current type fits use case
+- Explain characteristics of full/hybrid/standalone
+- If converting, guide through structural changes
+- Ensure all pieces align with new type
+  </action>
+
+<action>Throughout improvements, educate when helpful:
+
+Share insights from the guides naturally:
+
+- "The agent architecture guide suggests {{pattern}} for this scenario"
+- "Looking at the command patterns, we could use {{approach}}"
+- "The communication styles guide has a great example of {{technique}}"
+
+Connect improvements to broader BMAD principles without being preachy.
+</action>
+
+<ask>After each significant change:
+
+- "Does this feel right for what you're trying to achieve?"
+- "Want to refine this further, or move to the next improvement?"
+- "Is there anything about this change that concerns you?"
+  </ask>
+
+<template-output>improvement_implementation</template-output>
+</step>
+
+<step n="4" goal="Validate improvements holistically">
+<action>Run comprehensive validation conversationally:
+
+Don't just check boxes - explain what you're validating and why it matters:
+
+- "Let me verify all the workflow paths resolve correctly..."
+- "Checking that the activation flow works smoothly..."
+- "Making sure menu handlers are wired up properly..."
+- "Validating config loading is robust..."
+  </action>
+
+<action>Load validation checklist: {installed_path}/checklist.md</action>
+<action>Check all items from checklist systematically</action>
+
+<check if="validation_issues_found">
+  <action>Present issues conversationally:
+
+Explain what's wrong and implications:
+
+- "I found {{issue}} which could cause {{problem}}"
+- "The {{component}} needs {{fix}} because {{reason}}"
+
+Propose fixes immediately:
+
+- "I can fix this by {{solution}}. Should I?"
+- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?"
+  </action>
+
+<action>Fix approved issues and re-validate</action>
+</check>
+
+<check if="validation_passes">
+  <action>Confirm success warmly:
+
+"Excellent! Everything validates cleanly:
+
+- All paths resolve correctly
+- Activation flow is solid
+- Menu structure is clear
+- Handlers work properly
+- Config loading is robust
+
+Your agent is in great shape."
+</action>
+</check>
+
+<template-output>validation_results</template-output>
+</step>
+
+<step n="5" goal="Review improvements and guide next steps">
+<action>Create a conversational summary of what improved:
+
+Tell the story of the transformation:
+
+- "We started with {{initial_state}}"
+- "You wanted to {{user_goals}}"
+- "We made these key improvements: {{changes_list}}"
+- "Now your agent {{improved_capabilities}}"
+
+Highlight the impact:
+
+- "This means users will experience {{benefit}}"
+- "The agent is now more {{quality}}"
+- "It follows best practices for {{patterns}}"
+  </action>
+
+<action>Guide next steps based on changes made:
+
+If significant structural changes:
+
+- "Since we restructured the activation, you should test the agent with a real user interaction"
+
+If workflow references changed:
+
+- "The agent now uses {{new_workflows}} - make sure those workflows are up to date"
+
+If this is part of larger module work:
+
+- "This agent is part of {{module}} - consider if other agents need similar improvements"
+
+Be a helpful guide to what comes next, not just a task completer.
+</action>
+
+<ask>Would you like to:
+
+- Test the edited agent by invoking it
+- Edit another agent
+- Make additional refinements to this one
+- Return to your module work
+  </ask>
+
+<template-output>completion_summary</template-output>
+</step>
+
+</workflow>

package/bmad/bmb/workflows/edit-agent/workflow.yaml

@@ -0,0 +1,33 @@
+# Edit Agent - Agent Editor Configuration
+name: "edit-agent"
+description: "Edit existing BMAD agents while following all best practices and conventions"
+author: "BMad"
+
+# Critical variables load from config_source
+config_source: "{project-root}/bmad/bmb/config.yaml"
+communication_language: "{config_source}:communication_language"
+user_name: "{config_source}:user_name"
+
+# Required Data Files - Critical for understanding agent conventions
+agent_types: "{project-root}/bmad/bmb/workflows/create-agent/agent-types.md"
+agent_architecture: "{project-root}/bmad/bmb/workflows/create-agent/agent-architecture.md"
+agent_commands: "{project-root}/bmad/bmb/workflows/create-agent/agent-command-patterns.md"
+communication_styles: "{project-root}/bmad/bmb/workflows/create-agent/communication-styles.md"
+
+# Workflow execution engine reference
+workflow_execution_engine: "{project-root}/bmad/core/tasks/workflow.xml"
+
+# Optional docs that can be used to understand the target agent
+recommended_inputs:
+  - target_agent: "Path to the agent.yaml or agent.md file to edit"
+  - example_agents: "{project-root}/bmad/bmm/agents/"
+  - agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmb/workflows/edit-agent"
+template: false # This is an action workflow - no template needed
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+standalone: true
+# Web bundle configuration

package/bmad/bmb/workflows/edit-module/README.md

@@ -0,0 +1,187 @@
+# Edit Module Workflow
+
+Interactive workflow for editing existing BMAD modules, including structure, agents, workflows, configuration, and documentation.
+
+## Purpose
+
+This workflow helps you improve and maintain BMAD modules by:
+
+- Analyzing module structure against best practices
+- Managing agents and workflows within the module
+- Updating configuration and documentation
+- Ensuring cross-module integration works correctly
+- Maintaining installer configuration (for source modules)
+
+## When to Use
+
+Use this workflow when you need to:
+
+- Add new agents or workflows to a module
+- Update module configuration
+- Improve module documentation
+- Reorganize module structure
+- Set up cross-module workflow sharing
+- Fix issues in module organization
+- Update installer configuration
+
+## What You'll Need
+
+- Path to the module directory you want to edit
+- Understanding of what changes you want to make
+- Access to module documentation (loaded automatically)
+
+## Workflow Steps
+
+1. **Load and analyze target module** - Provide path to module directory
+2. **Analyze against best practices** - Automatic audit of module structure
+3. **Select editing focus** - Choose what aspect to edit
+4. **Load relevant documentation and tools** - Auto-loads guides and workflows
+5. **Perform edits** - Review and approve changes iteratively
+6. **Validate all changes** - Comprehensive validation checklist
+7. **Generate change summary** - Summary of improvements made
+
+## Editing Options
+
+The workflow provides 12 focused editing options:
+
+1. **Fix critical issues** - Address missing files, broken references
+2. **Update module config** - Edit config.yaml fields
+3. **Manage agents** - Add, edit, or remove agents
+4. **Manage workflows** - Add, edit, or remove workflows
+5. **Update documentation** - Improve README files and guides
+6. **Reorganize structure** - Fix directory organization
+7. **Add new agent** - Create and integrate new agent
+8. **Add new workflow** - Create and integrate new workflow
+9. **Update installer** - Modify installer configuration (source only)
+10. **Cross-module integration** - Set up workflow sharing with other modules
+11. **Remove deprecated items** - Delete unused agents, workflows, or files
+12. **Full module review** - Comprehensive analysis and improvements
+
+## Integration with Other Workflows
+
+This workflow integrates with:
+
+- **edit-agent** - For editing individual agents
+- **edit-workflow** - For editing individual workflows
+- **create-agent** - For adding new agents
+- **create-workflow** - For adding new workflows
+
+When you select options to manage agents or workflows, the appropriate specialized workflow is invoked automatically.
+
+## Module Structure
+
+A proper BMAD module has:
+
+```
+module-code/
+├── agents/              # Agent definitions
+│   └── *.agent.yaml
+├── workflows/           # Workflow definitions
+│   └── workflow-name/
+│       ├── workflow.yaml
+│       ├── instructions.md
+│       ├── checklist.md
+│       └── README.md
+├── config.yaml          # Module configuration
+└── README.md           # Module documentation
+```
+
+## Standard Module Config
+
+Every module config.yaml should have:
+
+```yaml
+module_name: 'Full Module Name'
+module_code: 'xyz'
+user_name: 'User Name'
+communication_language: 'english'
+output_folder: 'path/to/output'
+```
+
+Optional fields may be added for module-specific needs.
+
+## Cross-Module Integration
+
+Modules can share workflows:
+
+```yaml
+# In agent menu item:
+workflow: '{project-root}/bmad/other-module/workflows/shared-workflow/workflow.yaml'
+```
+
+Common patterns:
+
+- BMM uses CIS brainstorming workflows
+- All modules can use core workflows
+- Modules can invoke each other's workflows
+
+## Output
+
+The workflow modifies module files in place, including:
+
+- config.yaml
+- Agent files
+- Workflow files
+- README and documentation files
+- Directory structure (if reorganizing)
+
+Changes are reviewed and approved by you before being applied.
+
+## Best Practices
+
+- **Start with analysis** - Let the workflow audit your module first
+- **Use specialized workflows** - Let edit-agent and edit-workflow handle detailed edits
+- **Update documentation** - Keep README files current with changes
+- **Validate thoroughly** - Use the validation step to catch structural issues
+- **Test after editing** - Invoke agents and workflows to verify they work
+
+## Tips
+
+- For adding agents/workflows, use options 7-8 to create and integrate in one step
+- For quick config changes, use option 2 (update module config)
+- Cross-module integration (option 10) helps set up workflow sharing
+- Full module review (option 12) is great for inherited or legacy modules
+- The workflow handles path updates when you reorganize structure
+
+## Source vs Installed Modules
+
+**Source modules** (in src/modules/):
+
+- Have installer files in tools/cli/installers/
+- Can configure web bundles
+- Are the development source of truth
+
+**Installed modules** (in bmad/):
+
+- Are deployed to target projects
+- Use config.yaml for user customization
+- Are compiled from source during installation
+
+This workflow works with both, but installer options only apply to source modules.
+
+## Example Usage
+
+```
+User: I want to add a new workflow to BMM for API design
+Workflow: Analyzes BMM → You choose option 8 (add new workflow)
+          → Invokes create-workflow → Creates workflow
+          → Integrates it into module → Updates README → Done
+```
+
+## Activation
+
+Invoke via BMad Builder agent:
+
+```
+/bmad:bmb:agents:bmad-builder
+Then select: *edit-module
+```
+
+Or directly via workflow.xml with this workflow config.
+
+## Related Resources
+
+- **Module Structure Guide** - Comprehensive module architecture documentation
+- **BMM Module** - Example of full-featured module
+- **BMB Module** - Example of builder/tooling module
+- **CIS Module** - Example of workflow library module

package/bmad/bmb/workflows/edit-module/checklist.md

@@ -0,0 +1,165 @@
+# Edit Module - Validation Checklist
+
+Use this checklist to validate module edits meet BMAD Core standards.
+
+## Module Structure Validation
+
+- [ ] Module has clear 3-letter code (bmm, bmb, cis, etc.)
+- [ ] Module is in correct location (src/modules/ for source, bmad/ for installed)
+- [ ] agents/ directory exists
+- [ ] workflows/ directory exists
+- [ ] config.yaml exists in module root
+- [ ] README.md exists in module root
+- [ ] Directory structure follows BMAD conventions
+
+## Configuration Validation
+
+### Required Fields
+
+- [ ] module_name is descriptive and clear
+- [ ] module_code is 3-letter code matching directory name
+- [ ] user_name field present
+- [ ] communication_language field present
+- [ ] output_folder field present
+
+### Optional Fields (if used)
+
+- [ ] custom_agent_location documented
+- [ ] custom_module_location documented
+- [ ] Module-specific fields documented in README
+
+### File Quality
+
+- [ ] config.yaml is valid YAML syntax
+- [ ] No duplicate keys
+- [ ] Values are appropriate types (strings, paths, etc.)
+- [ ] Comments explain non-obvious fields
+
+## Agent Validation
+
+### Agent Files
+
+- [ ] All agents in agents/ directory
+- [ ] Agent files follow naming: {agent-name}.agent.yaml or .md
+- [ ] Agent filenames use kebab-case
+- [ ] No orphaned or temporary agent files
+
+### Agent Content
+
+- [ ] Each agent has clear role and purpose
+- [ ] Agents reference workflows correctly
+- [ ] Agent workflow paths are valid
+- [ ] Agents load module config correctly (if needed)
+- [ ] Agent menu items reference existing workflows
+
+### Agent Integration
+
+- [ ] All agents listed in module README
+- [ ] Agent relationships documented (if applicable)
+- [ ] Cross-agent workflows properly linked
+
+## Workflow Validation
+
+### Workflow Structure
+
+- [ ] All workflows in workflows/ directory
+- [ ] Each workflow directory has workflow.yaml
+- [ ] Each workflow directory has instructions.md
+- [ ] Workflow directories use kebab-case naming
+- [ ] No orphaned or incomplete workflow directories
+
+### Workflow Content
+
+- [ ] workflow.yaml is valid YAML
+- [ ] workflow.yaml has name field
+- [ ] workflow.yaml has description field
+- [ ] workflow.yaml has author field
+- [ ] instructions.md has proper <workflow> structure
+- [ ] Workflow steps are numbered and logical
+
+### Workflow Integration
+
+- [ ] All workflows listed in module README
+- [ ] Workflow paths in agents are correct
+- [ ] Cross-module workflow references are valid
+- [ ] Sub-workflow references exist
+
+## Documentation Validation
+
+### Module README
+
+- [ ] Module README describes purpose clearly
+- [ ] README lists all agents with descriptions
+- [ ] README lists all workflows with descriptions
+- [ ] README includes installation instructions (if applicable)
+- [ ] README explains module's role in BMAD ecosystem
+
+### Workflow READMEs
+
+- [ ] Each workflow has its own README.md
+- [ ] Workflow READMEs explain purpose
+- [ ] Workflow READMEs list inputs/outputs
+- [ ] Workflow READMEs include usage examples
+
+### Other Documentation
+
+- [ ] Usage guides present (if needed)
+- [ ] Architecture docs present (if complex module)
+- [ ] Examples provided (if applicable)
+
+## Cross-References Validation
+
+- [ ] Agent workflow references point to existing workflows
+- [ ] Workflow sub-workflow references are valid
+- [ ] Cross-module references use correct paths
+- [ ] Config file paths use {project-root} correctly
+- [ ] No hardcoded absolute paths
+
+## Installer Validation (Source Modules Only)
+
+- [ ] Installer script exists in tools/cli/installers/
+- [ ] Installer script name: install-{module-code}.js
+- [ ] Module metadata in installer is correct
+- [ ] Web bundle configuration valid (if applicable)
+- [ ] Installation paths are correct
+- [ ] Dependencies documented in installer
+
+## Web Bundle Validation (If Applicable)
+
+- [ ] Web bundles configured in workflow.yaml files
+- [ ] All referenced files included in web_bundle_files
+- [ ] Paths are bmad/-relative (not project-root)
+- [ ] No config_source references in web bundles
+- [ ] Invoked workflows included in dependencies
+
+## Quality Checks
+
+- [ ] No placeholder text remains ({MODULE_NAME}, {CODE}, etc.)
+- [ ] No broken file references
+- [ ] No duplicate content across files
+- [ ] Consistent naming conventions throughout
+- [ ] Module purpose is clear from README alone
+
+## Integration Checks
+
+- [ ] Module doesn't conflict with other modules
+- [ ] Shared resources properly documented
+- [ ] Dependencies on other modules explicit
+- [ ] Module can be installed independently (if designed that way)
+
+## User Experience
+
+- [ ] Module purpose is immediately clear
+- [ ] Agents have intuitive names
+- [ ] Workflows have descriptive names
+- [ ] Menu items are logically organized
+- [ ] Error messages are helpful
+- [ ] Success messages confirm actions
+
+## Final Checks
+
+- [ ] All files have been saved
+- [ ] File permissions are correct
+- [ ] Git status shows expected changes
+- [ ] Module is ready for testing
+- [ ] Documentation accurately reflects changes