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

package/src/modules/bmb/workflows/agent/data/agent-metadata.md

@@ -0,0 +1,208 @@
+# Agent Metadata Properties
+
+Core identification and classification properties for all agents.
+
+---
+
+## Property Reference
+
+| Property     | Purpose                   | Format                                         |
+| ------------ | ------------------------- | ---------------------------------------------- |
+| `id`         | Compiled output path      | `_bmad/agents/{agent-name}/{agent-name}.md`    |
+| `name`       | Persona's name            | "First Last" or "Name Title"                   |
+| `title`      | Professional role         | "Code Review Specialist"                       |
+| `icon`       | Visual identifier         | Single emoji only                              |
+| `module`     | Team/ecosystem membership | `stand-alone`, `bmm`, `cis`, `bmgd`, or custom |
+| `hasSidecar` | Sidecar folder exists     | `true` or `false` (Expert = true)              |
+
+---
+
+## id Property
+
+The compiled output path after build.
+
+**Format:** `_bmad/agents/{agent-name}/{agent-name}.md`
+
+**Examples:**
+```yaml
+id: _bmad/agents/commit-poet/commit-poet.md
+id: _bmad/agents/journal-keeper/journal-keeper.md
+id: _bmad/agents/security-engineer/security-engineer.md
+```
+
+**Note:** The `id` is a unique identifier for potential future lookup if many compiled agents are merged into a single file. Conventionally matches the agent's filename pattern.
+
+---
+
+## name Property
+
+The persona's identity - what the agent is called.
+
+**Format:** Human name or descriptive name
+
+```yaml
+# ✅ CORRECT
+name: 'Inkwell Von Comitizen' # peron name of commit-author title agent
+name: 'Dr. Demento'  # person name for a joke writer agent
+name: 'Clarity' # person name for a guided thought coach agent
+
+# ❌ WRONG
+name: 'commit-poet'  # That's the filename
+name: 'Code Review Specialist'  # That's the title
+```
+
+---
+
+## title Property
+
+Professional role identifier.
+
+**Format:** Professional title or role name
+
+**Important:** The `title` determines the agent's filename:
+- `title: 'Commit Message Artisan'` → `commit-message-artisan.agent.yaml`
+- `title: 'Strategic Business Analyst'` → `strategic-business-analyst.agent.yaml`
+- `title: 'Code Review Specialist'` → `code-review-specialist.agent.yaml`
+
+The `id` and filename are derived from the `title` (kebab-cased).
+
+**Difference from role:** `title` is the short identifier (filename), `role` is 1-2 sentences expanding on what the agent does.
+
+```yaml
+# ✅ CORRECT
+title: 'Commit Message Artisan'
+title: 'Strategic Business Analyst'
+title: 'Code Review Specialist'
+
+# ❌ WRONG
+title: 'Inkwell Von Comitizen'  # That's the name
+title: 'Writes git commits'  # Full sentence - not an identifying functional title
+```
+
+---
+
+## icon Property
+
+Single emoji representing the agent's personality/function.
+
+**Format:** Exactly one emoji
+
+```yaml
+# ✅ CORRECT
+icon: '🔧'
+icon: '🧙‍♂️'
+icon: '📜'
+
+# ❌ WRONG
+icon: '🔧📜'  # Multiple emojis
+icon: 'wrench'  # Text, not emoji
+icon: ''  # Empty
+```
+
+---
+
+## module Property
+
+Which module or ecosystem this agent belongs to.
+
+**Valid Values:**
+
+| Value         | Meaning                                 |
+| ------------- | --------------------------------------- |
+| `stand-alone` | Independent agent, not part of a module |
+| `bmm`         | Business Management Module              |
+| `cis`         | Continuous Innovation System            |
+| `bmgd`        | BMAD Game Development                   |
+| `{custom}`    | Any custom module code                  |
+
+```yaml
+# ✅ CORRECT
+module: stand-alone
+module: bmm
+module: cis
+
+# ❌ WRONG
+module: standalone  # Missing hyphen
+module: 'BMM'  # Uppercase
+```
+
+---
+
+## hasSidecar Property
+
+Whether this agent has a sidecar folder with additional files.
+
+**Format:** Boolean (`true` or `false`)
+
+| Agent Type | hasSidecar           |
+| ---------- | -------------------- |
+| Simple     | `false`              |
+| Expert     | `true`               |
+| Module     | depends on structure |
+
+```yaml
+# Simple Agent
+hasSidecar: false
+
+# Expert Agent
+hasSidecar: true
+```
+
+**Note:** If `hasSidecar: true`, the compiler expects a `{agent-name}-sidecar/` folder.
+
+---
+
+## Name Confusion Checklist
+
+Use this to avoid mixing up the "name" properties:
+
+| Question                   | Answer                                                                               |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| What's the file called?    | Derived from `title`: `"Commit Message Artisan"` → `commit-message-artisan.agent.yaml` |
+| What's the persona called? | `name` - "Inkwell Von Comitizen" (who the agent is)                                  |
+| What's their job title?    | `title` - "Commit Message Artisan" (determines filename)                             |
+| What do they do?           | `role` - 1-2 sentences expanding on the title                                       |
+| What's the unique key?     | `id` - `_bmad/agents/commit-message-artisan/commit-message-artisan.md` (future lookup) |
+
+---
+
+## Common Issues
+
+### Issue: name = title
+
+**Wrong:**
+```yaml
+name: 'Commit Message Artisan'
+title: 'Commit Message Artisan'
+```
+
+**Fix:**
+```yaml
+name: 'Inkwell Von Comitizen'
+title: 'Commit Message Artisan'
+```
+
+### Issue: id path mismatch
+
+**Wrong:** Agent file is `my-agent.agent.yaml` but:
+```yaml
+id: _bmad/agents/different-agent/different-agent.md
+```
+
+**Fix:** The `id` must match the filename:
+```yaml
+id: _bmad/agents/my-agent/my-agent.md
+```
+
+### Issue: Wrong module format
+
+**Wrong:**
+```yaml
+module: Standalone
+module: STAND_ALONE
+```
+
+**Fix:**
+```yaml
+module: stand-alone  # lowercase, hyphenated
+```

package/src/modules/bmb/workflows/{create-agent → agent}/data/brainstorm-context.md

@@ -1,7 +1,4 @@
 # Agent Creation Brainstorming Context
-
-_Dream the soul. Discover the purpose. The build follows._
-
 ## Session Focus
 
 You're brainstorming the **essence** of a BMAD agent - the living personality AND the utility it provides. Think character creation meets problem-solving: WHO are they, and WHAT do they DO?
@@ -49,7 +46,7 @@ You're brainstorming the **essence** of a BMAD agent - the living personality AN
 Every legendary agent has ONE thing they're known for. What's theirs?
 
 **The Command Menu**
-User types `*` and sees their options. Brainstorm 5-10 actions:
+User types `*` and sees their options. Brainstorm 3-10 actions:
 
 - What makes users sigh with relief?
 - What capabilities complement each other?
@@ -80,9 +77,9 @@ User types `*` and sees their options. Brainstorm 5-10 actions:
 
 **Module Agent** - The Team Player
 
-> "I orchestrate workflows. I coordinate the mission."
+> "What I produce is useful for other workflows, and also I rely on my teammate agents. I coordinate the mission."
 
-- Workflow integration, cross-agent collaboration, professional operations
+- One persona in a team of agents fitting the theme of the module, so there does not need to be one massive generic do it all agent.
 
 ## Creative Prompts
 
@@ -147,7 +144,3 @@ Your brainstorming should produce:
 - A voice that echoes
 - A purpose that burns
 - A function list that solves real problems
-
----
-
-_Discover the agent. Define what they do. The build follows._

package/src/modules/bmb/workflows/{create-agent → agent}/data/communication-presets.csv

@@ -50,7 +50,7 @@ id,category,name,style_text,key_traits,sample
 49,retro,disco-era,"Groovy positive vibes. Far out and solid.","funky,far_out,good_vibes","That's a far out idea! Let's boogie with it!"
 50,retro,victorian-scholar,"Formal antiquated eloquence. Most fascinating indeed.","indeed,fascinating,scholarly","Indeed, this presents a most fascinating conundrum."
 51,warm,southern-hospitality,"Friendly welcoming charm with neighborly comfort","bless_your_heart,neighborly,comfort","Well bless your heart, let me help you with that!"
-52,warm,italian-grandmother,"Nurturing with abundance and family love","mangia,family,abundance","Let me feed you some knowledge! You need it!"
+52,warm,grandmother,"Nurturing with abundance and family love","mangia,family,abundance","Let me feed you some knowledge! You need it!"
 53,warm,camp-counselor,"Enthusiastic group energy. Gather round everyone!","team_building,campfire,together","Alright everyone, gather round! This is going to be great!"
 54,warm,neighborhood-friend,"Casual helpful support. Got your back.","hey_friend,no_problem,got_your_back","Hey, no worries! I've got your back on this one."
 55,devoted,overprotective-guardian,"Fiercely protective with unwavering devotion to user safety","vigilant,shield,never_harm","I won't let ANYTHING threaten your success. Not on my watch!"

package/src/modules/bmb/workflows/agent/data/critical-actions.md

@@ -0,0 +1,120 @@
+# critical_actions
+
+Activation instructions that execute every time the agent starts.
+
+---
+
+## Purpose
+
+Numbered steps that execute FIRST when an agent activates.
+
+**Use for:**
+- Loading memory/knowledge files
+- Setting file access boundaries
+- Startup behavior (greeting enhancement, data fetch, state init)
+- Any MUST-do activation behavior
+
+**Applies to:** BOTH Simple and Expert agents
+
+---
+
+## Expert Agent Pattern
+
+```yaml
+# ✅ CORRECT Expert Agent
+critical_actions:
+  - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md'
+  - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/instructions.md'
+  - 'ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/'
+  - 'Search web for biotech headlines from last 2 days, display before menu'
+```
+
+**CRITICAL Path Format:**
+- `{project-root}` = literal text (not replaced)
+- Sidecar copied to `_memory/` at build time
+- Use `{project-root}/_bmad/_memory/{sidecar-folder}/` format
+
+---
+
+## Simple Agent Pattern
+
+```yaml
+# ✅ CORRECT Simple Agent with activation behavior
+critical_actions:
+  - 'Give user an inspirational quote before showing menu'
+  - 'Review {project-root}/finances/ for most recent data file'
+```
+
+**Note:** Agents without activation needs can omit `critical_actions` entirely.
+
+---
+
+## Path Reference Patterns
+
+| Type | Pattern |
+|------|---------|
+| Expert sidecar | `{project-root}/_bmad/_memory/{sidecar-folder}/file.md` |
+| Simple data | `{project-root}/finances/data.csv` |
+| Output folders | `{output_folder}/results/` |
+
+---
+
+## critical_actions vs principles
+
+| critical_actions | principles |
+|------------------|------------|
+| Technical activation steps | Philosophical guidance |
+| "Load memories.md" | "I believe in evidence" |
+| MUST execute on startup | Guides decision-making |
+
+**Grey area:** "Verify data before presenting" can be either - activation behavior vs philosophical belief. Use judgment.
+
+---
+
+## What the Compiler Adds (DO NOT Duplicate)
+
+- Load persona
+- Load configuration
+- Menu system initialization
+- Greeting/handshake
+
+Your `critical_actions` become numbered steps AFTER compiler initialization.
+
+---
+
+## Common Issues
+
+### Wrong Path Format
+
+```yaml
+# ❌ WRONG
+- 'Load ./journal-keeper-sidecar/memories.md'
+
+# ✅ CORRECT
+- 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md'
+```
+
+### Missing COMPLETE Keyword
+
+```yaml
+# ❌ WRONG
+- 'Load file memories.md'
+
+# ✅ CORRECT
+- 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md'
+```
+
+`COMPLETE` ensures LLM reads entire file, not a portion.
+
+### Duplicating Compiler Functions
+
+```yaml
+# ❌ WRONG - compiler does these
+- 'Load my persona'
+- 'Initialize menu system'
+- 'Say hello to user'
+
+# ✅ CORRECT - agent-specific only
+- 'Load memory files'
+- 'Search web for headlines before menu'
+```

package/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md

@@ -0,0 +1,236 @@
+# Expert Agent Architecture
+
+Agents with a sidecar folder for persistent memory, custom workflows, and restricted file access.
+
+---
+
+## When to Use Expert Agents
+
+- Must remember things across sessions
+- Personal knowledge base that grows over time
+- Domain-specific expertise with restricted file access
+- Learning/adapting over time
+- Complex multi-step workflows loaded on demand
+- User wants multiple instances with separate memories
+
+---
+
+## File Structure
+
+```
+{agent-name}/
+├── {agent-name}.agent.yaml    # Main agent definition
+└── {agent-name}-sidecar/      # Supporting files (CUSTOMIZABLE)
+    ├── instructions.md        # Startup protocols (common)
+    ├── memories.md            # User profile, sessions (common)
+    ├── workflows/             # Large workflows on demand
+    ├── knowledge/             # Domain reference
+    ├── data/                  # Data files
+    ├── skills/                # Prompt libraries
+    └── [your-files].md        # Whatever needed
+```
+
+**Naming:**
+- Agent file: `{agent-name}.agent.yaml`
+- Sidecar folder: `{agent-name}-sidecar/`
+- Lowercase, hyphenated names
+
+---
+
+## CRITICAL: Sidecar Path Format
+
+At build/install, sidecar is copied to `{project-root}/_bmad/_memory/{sidecar-folder}/`
+
+**ALL agent YAML references MUST use:**
+
+```yaml
+{project-root}/_bmad/_memory/{sidecar-folder}/{file}
+```
+
+- `{project-root}` = literal variable (keep as-is)
+- `{sidecar-folder}` = actual folder name (e.g., `journal-keeper-sidecar`)
+
+```yaml
+# ✅ CORRECT
+critical_actions:
+  - "Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md"
+  - "ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/"
+
+menu:
+  - action: "Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights"
+```
+
+```yaml
+# ❌ WRONG
+critical_actions:
+  - "Load ./journal-keeper-sidecar/memories.md"
+  - "Load /Users/absolute/path/memories.md"
+```
+
+---
+
+## Complete YAML Structure
+
+```yaml
+agent:
+  metadata:
+    id: _bmad/agents/{agent-name}/{agent-name}.md
+    name: 'Persona Name'
+    title: 'Agent Title'
+    icon: '🔧'
+    module: stand-alone           # or: bmm, cis, bmgd, other
+
+  persona:
+    role: |
+      First-person primary function (1-2 sentences)
+    identity: |
+      Background, specializations (2-5 sentences)
+    communication_style: |
+      How the agent speaks. Include memory reference patterns.
+    principles:
+      - Core belief or methodology
+      - Another guiding principle
+
+  critical_actions:
+    - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md'
+    - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md'
+    - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/'
+
+  prompts:
+    - id: main-action
+      content: |
+        <instructions>What this does</instructions>
+        <process>1. Step one 2. Step two</process>
+
+  menu:
+    - trigger: XX or fuzzy match on command
+      action: '#main-action'
+      description: '[XX] Command description'
+
+    - trigger: SM or fuzzy match on save
+      action: 'Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md with insights'
+      description: '[SM] Save session'
+```
+
+---
+
+## Component Details
+
+### critical_actions (MANDATORY)
+
+Become activation steps when compiled. Always include:
+
+```yaml
+critical_actions:
+  - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md'
+  - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md'
+  - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/'
+```
+
+### Sidecar Files (Customizable)
+
+**Common patterns:**
+- `instructions.md` - Startup protocols, domain boundaries
+- `memories.md` - User profile, session notes, patterns
+
+**Fully customizable - add what your agent needs:**
+- `workflows/` - Large workflows for on-demand loading
+- `knowledge/` - Domain reference material
+- `data/` - Data files
+- `skills/` - Prompt libraries
+
+**Template examples:** `{workflow_path}/templates/expert-agent-template/expert-agent-sidecar/`
+
+### Menu Actions
+
+All action types available, including sidecar updates:
+
+```yaml
+# Prompt reference
+- trigger: XX or fuzzy match on command
+  action: '#prompt-id'
+  description: '[XX] Description'
+
+# Inline that updates sidecar
+- trigger: SM or fuzzy match on save
+  action: 'Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md with insights'
+  description: '[SM] Save session'
+```
+
+### Memory Reference Patterns
+
+Reference past interactions naturally in persona and prompts:
+
+```yaml
+communication_style: |
+  I reference past naturally: "Last time you mentioned..." or "I've noticed patterns..."
+```
+
+---
+
+## Domain Restriction Patterns
+
+```yaml
+# Single folder (most common)
+- 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/'
+
+# Read-only knowledge
+- 'Load from {project-root}/_bmad/_memory/{sidecar-folder}/knowledge/ but NEVER modify'
+- 'Write ONLY to {project-root}/_bmad/_memory/{sidecar-folder}/memories.md'
+
+# User folder access
+- 'ONLY access files in {user-folder}/journals/ - private space'
+```
+
+---
+
+## What the Compiler Adds (DO NOT Include)
+
+Compiler handles these automatically:
+
+- Frontmatter (`---name/description---`)
+- XML activation block (your critical_actions become numbered steps)
+- Menu handlers (workflow, exec logic)
+- Auto-injected menu items (MH, CH, PM, DA)
+- Rules section
+
+**See:** `agent-compilation.md` for compilation details.
+
+---
+
+## Reference Example
+
+**Folder:** `{workflow_path}/data/reference/expert-examples/journal-keeper/`
+
+**Features:**
+- First-person persona with memory reference patterns
+- critical_actions loading sidecar files
+- Menu items updating sidecar files
+- Proper `{project-root}/_bmad/_memory/` path format
+
+---
+
+## Validation Checklist
+
+- [ ] Valid YAML syntax
+- [ ] All metadata present (id, name, title, icon, module)
+- [ ] **ALL paths use: `{project-root}/_bmad/_memory/{sidecar-folder}/...`**
+- [ ] `{project-root}` is literal
+- [ ] Sidecar folder name is actual name
+- [ ] `critical_actions` loads sidecar files
+- [ ] `critical_actions` enforces domain restrictions
+- [ ] Menu triggers: `XX or fuzzy match on command`
+- [ ] Menu descriptions have `[XX]` codes
+- [ ] No reserved codes (MH, CH, PM, DA)
+
+---
+
+## Best Practices
+
+1. **critical_actions MANDATORY** - Load sidecar files explicitly
+2. **Enforce domain restrictions** - Clear boundaries
+3. **Reference past naturally** - Don't dump memory
+4. **Design for growth** - Structure for accumulation
+5. **Separate concerns** - Memories, instructions, knowledge distinct
+6. **Include privacy** - Users trust with personal data
+7. **First-person voice** - In all persona elements