2.0 KiB
2.0 KiB
BMB Module Documentation
Reference documentation for building BMAD agents and workflows.
Agent Architecture
Comprehensive guides for each agent type (choose based on use case):
- Understanding Agent Types - START HERE - Architecture vs capability, "The Same Agent, Three Ways"
- Simple Agent Architecture - Self-contained, optimized, personality-driven
- Expert Agent Architecture - Memory, sidecar files, domain restrictions
- Module Agent Architecture - Workflow integration, professional tools
Agent Design Patterns
- Agent Menu Patterns - Menu handlers, triggers, prompts, organization
- Agent Compilation - What compiler auto-injects (AVOID DUPLICATION)
Reference Examples
Production-ready examples in /src/modules/bmb/reference/agents/:
Simple Agents (simple-examples/)
commit-poet.agent.yaml- Commit message artisan with style customization
Expert Agents (expert-examples/)
journal-keeper/- Personal journal companion with memory and pattern recognition
Module Agents (module-examples/)
security-engineer.agent.yaml- BMM security specialist with threat modelingtrend-analyst.agent.yaml- CIS trend intelligence expert
Installation Guide
For installing standalone simple and expert agents, see:
Key Concepts
YAML to XML Compilation
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
- Frontmatter - Name and description from metadata
- Activation Block - Steps, menu handlers, rules (YOU don't write this)
- Menu Enhancement -
*helpand*exitcommands added automatically - Trigger Prefixing - Your triggers auto-prefixed with
*
Critical: See Agent Compilation to avoid duplicating auto-injected content.
Source: tools/cli/lib/agent/compiler.js