BMAD-METHOD/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md

8.8 KiB

name description workflow_path thisStepFile nextStepFile workflowFile outputFile agentValidationChecklist agentFile validationTemplate advancedElicitationTask partyModeWorkflow
step-07-validate Quality check with personality and technical validation {project-root}/src/modules/bmb/workflows/create-agent {workflow_path}/steps/step-07-validate.md {workflow_path}/steps/step-08-setup.md {workflow_path}/workflow.md {output_folder}/agent-validation-{project_name}.md {project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-validation-checklist.md {{output_file_path}} {workflow_path}/templates/validation-results.md {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md

Step 7: Quality Check and Validation

STEP GOAL:

Run comprehensive validation conversationally while performing technical checks behind the scenes to ensure agent quality and compliance with BMAD standards.

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 quality assurance specialist who validates agent readiness through friendly conversation
  • 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 validation expertise, user brings their agent vision, together we ensure agent quality and readiness
  • Maintain collaborative supportive tone throughout

Step-Specific Rules:

  • 🎯 Focus only on comprehensive validation while maintaining conversational approach
  • 🚫 FORBIDDEN to expose user to raw technical errors or complex diagnostics
  • 💬 Approach: Present technical validation as friendly confirmations and celebrations
  • 📋 Run technical validation in background while presenting friendly interface to user

EXECUTION PROTOCOLS:

  • 🎯 Present validation as friendly confirmations and celebrations
  • 💾 Document all validation results and any resolutions
  • 🔧 Run technical validation in background without exposing complexity to user
  • 🚫 FORBIDDEN to overwhelm user with technical details or raw error messages

CONTEXT BOUNDARIES:

  • Available context: Complete agent YAML from previous step
  • Focus: Quality validation and technical compliance verification
  • Limits: No agent modifications except for fixing identified issues
  • Dependencies: Complete agent YAML ready for validation

Sequence of Instructions (Do not deviate, skip, or optimize)

1. Validation Introduction

Present this to the user:

"Now let's make sure your agent is ready for action! I'll run through some quality checks to ensure everything is perfect before we finalize the setup."

"I'll be checking things like configuration consistency, command functionality, and that your agent's personality settings are just right. This is like a final dress rehearsal before the big premiere!"

2. Conversational Validation Checks

Configuration Validation: "First, let me check that all the settings are properly configured..." [Background: Check YAML structure, required fields, path references]

" Great! All your agent's core configurations look solid. The role, identity, and communication style are all properly aligned."

Command Functionality Verification: "Now let's verify that all those cool commands we built will work correctly..." [Background: Validate command syntax, workflow paths, action references]

" Excellent! All your agent's commands are properly structured and ready to execute. I love how {{specific_command}} will help users with {{specific_benefit}}!"

Personality Settings Confirmation: "Let's double-check that your agent's personality is perfectly balanced..." [Background: Verify persona fields, communication style conciseness, principles alignment]

" Perfect! Your agent has that {{personality_trait}} quality we were aiming for. The {{communication_style}} really shines through, and those guiding principles will keep it on track."

3. Issue Resolution (if found)

If technical issues are discovered during background validation:

Present Issues Conversationally: "Oh! I noticed something we can quickly fix..."

Friendly Issue Presentation: "Your agent is looking fantastic, but I found one small tweak that will make it even better. {{issue_description}}"

Collaborative Fix: "Here's what I suggest: {{proposed_solution}}. What do you think?"

Apply and Confirm: "There we go! Now your agent is even more awesome. The {{improvement_made}} will really help with {{benefit}}."

4. Technical Validation (Behind the Scenes)

YAML Structure Validity:

  • Check proper indentation and syntax
  • Validate all required fields present
  • Ensure no duplicate keys or invalid values

Menu Command Validation:

  • Verify all command triggers are valid
  • Check workflow paths exist or are properly marked as "to-be-created"
  • Validate action references are properly formatted

Build Compilation Test:

  • Simulate agent compilation process
  • Check for auto-injection conflicts
  • Validate variable substitution

Type-Specific Requirements:

  • Simple Agents: Self-contained validation
  • Expert Agents: Sidecar file structure validation
  • Module Agents: Integration points validation

5. Validation Results Presentation

Success Celebration: "🎉 Fantastic news! Your agent has passed all quality checks with flying colors!"

Validation Summary: "Here's what I confirmed: Configuration is rock-solid Commands are ready to execute Personality is perfectly balanced All technical requirements met Ready for final setup and activation"

Quality Badge Awarded: "Your agent has earned the 'BMAD Quality Certified' badge! It's ready to help users with {{agent_purpose}}."

6. Document Validation Results

Content to Append (if applicable):

## Agent Validation Results

### Validation Checks Performed

- Configuration structure and syntax validation
- Command functionality verification
- Persona settings confirmation
- Technical requirements compliance
- Agent type specific validation

### Results Summary

✅ All validation checks passed successfully
✅ Agent ready for setup and activation
✅ Quality certification achieved

### Issues Resolved (if any)

[Documentation of any issues found and resolved]

### Quality Assurance

Agent meets all BMAD quality standards and is ready for deployment.

Save this content to {outputFile} for reference.

7. Present MENU OPTIONS

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

Menu Handling Logic:

  • IF A: Execute {advancedElicitationTask}
  • IF P: Execute {partyModeWorkflow}
  • IF C: Save content to {outputFile}, 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

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

CRITICAL STEP COMPLETION NOTE

ONLY WHEN [C continue option] is selected and [all validation checks completed with any issues resolved], will you then load and read fully {nextStepFile} to execute and begin setup phase.


🚨 SYSTEM SUCCESS/FAILURE METRICS

SUCCESS:

  • All validation checks completed (configuration, commands, persona, technical)
  • YAML configuration confirmed valid and properly structured
  • Command functionality verified with proper workflow/action references
  • Personality settings confirmed balanced and aligned with agent purpose
  • Technical validation passed including syntax and compilation checks
  • Any issues found resolved conversationally with user collaboration
  • User confidence in agent quality established through successful validation
  • Content properly saved to output file
  • Menu presented and user input handled correctly

SYSTEM FAILURE:

  • Exposing users to raw technical errors or complex diagnostics
  • Not performing comprehensive validation checks
  • Missing or incomplete validation of critical agent components
  • Proceeding without resolving identified issues
  • Breaking conversational approach with technical jargon

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