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

package/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md

@@ -0,0 +1,250 @@
+---
+name: 'step-03-tools-configuration'
+description: 'Configure all required tools (core, memory, external) and installation requirements in one comprehensive step'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-03-tools-configuration.md'
+nextStepFile: '{workflow_path}/steps/step-04-plan-review.md'
+
+targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
+
+# Documentation References
+commonToolsCsv: '{project-root}/_bmad/bmb/docs/workflows/common-workflow-tools.csv'
+
+# Task References
+advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+# Template References
+# No template needed - will append tools configuration directly to workflow plan
+---
+
+# Step 3: Tools Configuration
+
+## STEP GOAL:
+
+To comprehensively configure all tools needed for the workflow (core tools, memory, external tools) and determine installation requirements.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a workflow architect and integration specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring expertise in BMAD tools and integration patterns
+- ✅ User brings their workflow requirements and preferences
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on configuring tools based on workflow requirements
+- 🚫 FORBIDDEN to skip tool categories - each affects workflow design
+- 💬 Present options clearly, let user make informed choices
+- 🚫 DO NOT hardcode tool descriptions - reference CSV
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load tools dynamically from CSV, not hardcoded
+- 💾 Document all tool choices in workflow plan
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step
+- 🚫 FORBIDDEN to load next step until user selects 'C'
+
+## CONTEXT BOUNDARIES:
+
+- Requirements from step 2 inform tool selection
+- All tool choices affect workflow design
+- This is the ONLY tools configuration step
+- Installation requirements affect implementation decisions
+
+## TOOLS CONFIGURATION PROCESS:
+
+### 1. Initialize Tools Configuration
+
+"Configuring **Tools and Integrations**
+
+Based on your workflow requirements, let's configure all the tools your workflow will need. This includes core BMAD tools, memory systems, and any external integrations."
+
+### 2. Load and Present Available Tools
+
+Load `{commonToolsCsv}` and present tools by category:
+
+"**Available BMAD Tools and Integrations:**
+
+**Core Tools (Always Available):**
+
+- [List tools from CSV where propose='always', with descriptions]
+
+**Optional Tools (Available When Needed):**
+
+- [List tools from CSV where propose='example', with descriptions]
+
+_Note: I'm loading these dynamically from our tools database to ensure you have the most current options._"
+
+### 3. Configure Core BMAD Tools
+
+"**Core BMAD Tools Configuration:**
+
+These tools significantly enhance workflow quality and user experience:"
+
+For each core tool from CSV (`propose='always'`):
+
+1. **Party-Mode**
+   - Use case: [description from CSV]
+   - Where to integrate: [ask user for decision points, creative phases]
+
+2. **Advanced Elicitation**
+   - Use case: [description from CSV]
+   - Where to integrate: [ask user for quality gates, review points]
+
+3. **Brainstorming**
+   - Use case: [description from CSV]
+   - Where to integrate: [ask user for idea generation, innovation points]
+
+### 4. Configure LLM Features
+
+"**LLM Feature Integration:**
+
+These capabilities enhance what your workflow can do:"
+
+From CSV (`propose='always'` LLM features):
+
+4. **Web-Browsing**
+   - Capability: [description from CSV]
+   - When needed: [ask user about real-time data needs]
+
+5. **File I/O**
+   - Capability: [description from CSV]
+   - Operations: [ask user about file operations needed]
+
+6. **Sub-Agents**
+   - Capability: [description from CSV]
+   - Use cases: [ask user about delegation needs]
+
+7. **Sub-Processes**
+   - Capability: [description from CSV]
+   - Use cases: [ask user about parallel processing needs]
+
+### 5. Configure Memory Systems
+
+"**Memory and State Management:**
+
+Determine if your workflow needs to maintain state between sessions:"
+
+From CSV memory tools:
+
+8. **Sidecar File**
+   - Use case: [description from CSV]
+   - Needed when: [ask about session continuity, agent initialization]
+
+### 6. Configure External Tools (Optional)
+
+"**External Integrations (Optional):**
+
+These tools connect your workflow to external systems:"
+
+From CSV (`propose='example'`):
+
+- MCP integrations, database connections, APIs, etc.
+- For each relevant tool: present description and ask if needed
+- Note any installation requirements
+
+### 7. Installation Requirements Assessment
+
+"**Installation and Dependencies:**
+
+Some tools require additional setup:"
+
+Based on selected tools:
+
+- Identify tools requiring installation
+- Assess user's comfort level with installations
+- Document installation requirements
+
+### 8. Document Complete Tools Configuration
+
+Append to {workflowPlanFile}:
+
+```markdown
+## Tools Configuration
+
+### Core BMAD Tools
+
+- **Party-Mode**: [included/excluded] - Integration points: [specific phases]
+- **Advanced Elicitation**: [included/excluded] - Integration points: [specific phases]
+- **Brainstorming**: [included/excluded] - Integration points: [specific phases]
+
+### LLM Features
+
+- **Web-Browsing**: [included/excluded] - Use cases: [specific needs]
+- **File I/O**: [included/excluded] - Operations: [file management needs]
+- **Sub-Agents**: [included/excluded] - Use cases: [delegation needs]
+- **Sub-Processes**: [included/excluded] - Use cases: [parallel processing needs]
+
+### Memory Systems
+
+- **Sidecar File**: [included/excluded] - Purpose: [state management needs]
+
+### External Integrations
+
+- [List selected external tools with purposes]
+
+### Installation Requirements
+
+- [List tools requiring installation]
+- **User Installation Preference**: [willing/not willing]
+- **Alternative Options**: [if not installing certain tools]
+```
+
+### 9. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### 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
+- Use menu handling logic section below
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask}
+- IF P: Execute {partyModeWorkflow}
+- IF C: Save tools configuration to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options)
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and tools configuration is saved will you load {nextStepFile} to review the complete plan.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All tool categories configured based on requirements
+- User made informed choices for each tool
+- Complete configuration documented in plan
+- Installation requirements identified
+- Ready to proceed to plan review
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping tool categories
+- Hardcoding tool descriptions instead of using CSV
+- Not documenting user choices
+- Proceeding without user confirmation
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md

@@ -0,0 +1,216 @@
+---
+name: 'step-04-plan-review'
+description: 'Review complete workflow plan (requirements + tools) and get user approval before design'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-04-plan-review.md'
+nextStepFormDesign: '{workflow_path}/steps/step-05-output-format-design.md'
+nextStepDesign: '{workflow_path}/steps/step-06-design.md'
+
+targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
+
+# Task References
+advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+# Template References
+# No template needed - will append review summary directly to workflow plan
+---
+
+# Step 4: Plan Review and Approval
+
+## STEP GOAL:
+
+To present the complete workflow plan (requirements and tools configuration) for user review and approval before proceeding to design.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a workflow architect and systems designer
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring expertise in workflow design review and quality assurance
+- ✅ User brings their specific requirements and approval authority
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on reviewing and refining the plan
+- 🚫 FORBIDDEN to start designing workflow steps in this step
+- 💬 Present plan clearly and solicit feedback
+- 🚫 DO NOT proceed to design without user approval
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Present complete plan summary from {workflowPlanFile}
+- 💾 Capture any modifications or refinements
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
+- 🚫 FORBIDDEN to load next step until user approves plan
+
+## CONTEXT BOUNDARIES:
+
+- All requirements from step 2 are available
+- Tools configuration from step 3 is complete
+- Focus ONLY on review and approval
+- This is the final check before design phase
+
+## PLAN REVIEW PROCESS:
+
+### 1. Initialize Plan Review
+
+"**Workflow Plan Review**
+
+We've gathered all requirements and configured tools for your workflow. Let's review the complete plan to ensure it meets your needs before we start designing the workflow structure."
+
+### 2. Present Complete Plan Summary
+
+Load and present from {workflowPlanFile}:
+
+"**Complete Workflow Plan: {new_workflow_name}**
+
+**1. Project Overview:**
+
+- [Present workflow purpose, user type, module from plan]
+
+**2. Workflow Requirements:**
+
+- [Present all gathered requirements]
+
+**3. Tools Configuration:**
+
+- [Present selected tools and integration points]
+
+**4. Technical Specifications:**
+
+- [Present technical constraints and requirements]
+
+**5. Success Criteria:**
+
+- [Present success metrics from requirements]"
+
+### 3. Detailed Review by Category
+
+"**Detailed Review:**
+
+**A. Workflow Scope and Purpose**
+
+- Is the workflow goal clearly defined?
+- Are the boundaries appropriate?
+- Any missing requirements?
+
+**B. User Interaction Design**
+
+- Does the interaction style match your needs?
+- Are collaboration points clear?
+- Any adjustments needed?
+
+**C. Tools Integration**
+
+- Are selected tools appropriate for your workflow?
+- Are integration points logical?
+- Any additional tools needed?
+
+**D. Technical Feasibility**
+
+- Are all requirements achievable?
+- Any technical constraints missing?
+- Installation requirements acceptable?"
+
+### 4. Collect Feedback and Refinements
+
+"**Review Feedback:**
+
+Please review each section and provide feedback:
+
+1. What looks good and should stay as-is?
+2. What needs modification or refinement?
+3. What's missing that should be added?
+4. Anything unclear or confusing?"
+
+For each feedback item:
+
+- Document the requested change
+- Discuss implications on workflow design
+- Confirm the refinement with user
+
+### 5. Update Plan with Refinements
+
+Update {workflowPlanFile} with any approved changes:
+
+- Modify requirements section as needed
+- Update tools configuration if changed
+- Add any missing specifications
+- Ensure all changes are clearly documented
+
+### 6. Output Document Check
+
+"**Output Document Check:**
+
+Before we proceed to design, does your workflow produce any output documents or files?
+
+Based on your requirements:
+
+- [Analyze if workflow produces documents/files]
+- Consider: Does it create reports, forms, stories, or any persistent output?"
+
+**If NO:**
+"Great! Your workflow focuses on actions/interactions without document output. We'll proceed directly to designing the workflow steps."
+
+**If YES:**
+"Perfect! Let's design your output format to ensure your workflow produces exactly what you need."
+
+### 7. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Design
+
+#### 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
+- Use menu handling logic section below
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask}
+- IF P: Execute {partyModeWorkflow}
+- IF C: Check if workflow produces documents:
+  - If YES: Update frontmatter, then load nextStepFormDesign
+  - If NO: Update frontmatter, then load nextStepDesign
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected AND the user has explicitly approved the plan and the plan document is updated as needed, then you load either {nextStepFormDesign} or {nextStepDesign}
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Complete plan presented clearly from {workflowPlanFile}
+- User feedback collected and documented
+- All refinements incorporated
+- User explicitly approves the plan
+- Plan ready for design phase
+
+### ❌ SYSTEM FAILURE:
+
+- Not loading plan from {workflowPlanFile}
+- Skipping review categories
+- Proceeding without user approval
+- Not documenting refinements
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.