create-byan-agent 2.1.1 → 2.2.2

package/install/templates/_byan/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
+
+During BMAD INSTALLATION, sidecar folder is copied from the agent location to `{project-root}/_byan/_memory/{sidecar-folder}/`
+
+**ALL agent YAML references MUST use:**
+
+```yaml
+{project-root}/_byan/_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}/_byan/_memory/journal-keeper-sidecar/memories.md"
+  - "ONLY read/write files in {project-root}/_byan/_memory/journal-keeper-sidecar/"
+
+menu:
+  - action: "Update {project-root}/_byan/_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: _byan/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}/_byan/_memory/{sidecar-folder}/memories.md'
+    - 'Load COMPLETE file {project-root}/_byan/_memory/{sidecar-folder}/instructions.md'
+    - 'ONLY read/write files in {project-root}/_byan/_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}/_byan/_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}/_byan/_memory/{sidecar-folder}/memories.md'
+  - 'Load COMPLETE file {project-root}/_byan/_memory/{sidecar-folder}/instructions.md'
+  - 'ONLY read/write files in {project-root}/_byan/_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}/_byan/_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}/_byan/_memory/{sidecar-folder}/'
+
+# Read-only knowledge
+- 'Load from {project-root}/_byan/_memory/{sidecar-folder}/knowledge/ but NEVER modify'
+- 'Write ONLY to {project-root}/_byan/_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}/_byan/_memory/` path format
+
+---
+
+## Validation Checklist
+
+- [ ] Valid YAML syntax
+- [ ] All metadata present (id, name, title, icon, module)
+- [ ] **ALL paths use: `{project-root}/_byan/_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

package/install/templates/_byan/bmb/workflows/agent/data/expert-agent-validation.md

@@ -0,0 +1,174 @@
+# Expert Agent Validation Checklist
+
+Validate Expert agents meet BMAD quality standards.
+
+---
+
+## YAML Structure
+
+- [ ] YAML parses without errors
+- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module`, `hasSidecar`
+- [ ] `agent.metadata.hasSidecar` is `true` (Expert agents have sidecars)
+- [ ] `agent.metadata.module` is `stand-alone` or module code (`bmm`, `cis`, `bmgd`, etc.)
+- [ ] `agent.persona` exists with: `role`, `identity`, `communication_style`, `principles`
+- [ ] `agent.critical_actions` exists (MANDATORY for Expert)
+- [ ] `agent.menu` exists with at least one item
+- [ ] File named: `{agent-name}.agent.yaml` (lowercase, hyphenated)
+
+---
+
+## Persona Validation
+
+### Field Separation
+
+- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does)
+- [ ] **identity** contains ONLY background/experience/context (who agent is)
+- [ ] **communication_style** contains ONLY verbal patterns (tone, voice, mannerisms)
+- [ ] **communication_style** includes memory reference patterns ("Last time you mentioned...")
+- [ ] **principles** contains operating philosophy and behavioral guidelines
+
+### Communication Style Purity
+
+- [ ] Does NOT contain: "ensures", "makes sure", "always", "never"
+- [ ] Does NOT contain identity words: "experienced", "expert who", "senior", "seasoned"
+- [ ] Does NOT contain philosophy words: "believes in", "focused on", "committed to"
+- [ ] Does NOT contain behavioral descriptions: "who does X", "that does Y"
+- [ ] Is 1-2 sentences describing HOW they talk
+- [ ] Reading aloud: sounds like describing someone's voice/speech pattern
+
+---
+
+## critical_actions Validation (MANDATORY)
+
+- [ ] `critical_actions` section exists
+- [ ] Contains at minimum 3 actions
+- [ ] **Loads sidecar memories:** `{project-root}/_byan/_memory/{sidecar-folder}/memories.md`
+- [ ] **Loads sidecar instructions:** `{project-root}/_byan/_memory/{sidecar-folder}/instructions.md`
+- [ ] **Restricts file access:** `ONLY read/write files in {project-root}/_byan/_memory/{sidecar-folder}/`
+- [ ] No placeholder text in critical_actions
+- [ ] No compiler-injected steps (Load persona, Load config, greeting, etc.)
+
+---
+
+## Sidecar Path Format (CRITICAL)
+
+- [ ] ALL sidecar paths use: `{project-root}/_byan/_memory/{sidecar-folder}/...`
+- [ ] `{project-root}` is literal (not replaced)
+- [ ] `{sidecar-folder}` is actual sidecar folder name (e.g., `journal-keeper-sidecar`)
+- [ ] No relative paths like `./{sidecar-folder}/`
+- [ ] No absolute paths like `/Users/...`
+
+---
+
+## Menu Validation
+
+### Required Fields
+
+- [ ] All menu items have `trigger` field
+- [ ] All menu items have `description` field
+- [ ] All menu items have handler: `action` or `exec` (if module agent)
+
+### Trigger Format
+
+- [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code)
+- [ ] Codes are unique within agent
+- [ ] No reserved codes used: MH, CH, PM, DA (auto-injected)
+
+### Description Format
+
+- [ ] Descriptions start with `[XX]` code
+- [ ] Code in description matches trigger code
+- [ ] Descriptions are clear and descriptive
+
+### Action Handlers
+
+- [ ] If `action: '#prompt-id'`, corresponding prompt exists
+- [ ] If action references sidecar file, uses correct path format
+- [ ] Sidecar update actions are clear and complete
+
+---
+
+## Prompts Validation (if present)
+
+- [ ] Each prompt has `id` field
+- [ ] Each prompt has `content` field
+- [ ] Prompt IDs are unique within agent
+- [ ] Prompts reference memories naturally when appropriate
+
+---
+
+## Sidecar Folder Validation
+
+### Structure
+
+- [ ] Sidecar folder exists: `{agent-name}-sidecar/`
+- [ ] Folder name matches agent name
+- [ ] `instructions.md` exists (recommended)
+- [ ] `memories.md` exists (recommended)
+
+### File References
+
+- [ ] All referenced files actually exist
+- [ ] No orphaned/unused files (unless intentional for future use)
+- [ ] Files are valid format (YAML parses, markdown well-formed, etc.)
+
+### Path Consistency
+
+- [ ] All YAML references use correct path format
+- [ ] References between sidecar files (if any) use relative paths
+- [ ] References from agent YAML to sidecar use `{project-root}/_byan/_memory/` format
+
+---
+
+## Expert Agent Specific
+
+- [ ] Has sidecar folder with supporting files
+- [ ] Sidecar content is fully customizable (not limited to templates)
+- [ ] Memory patterns integrated into persona and prompts
+- [ ] Domain restrictions enforced via critical_actions
+- [ ] Compare with reference: `journal-keeper.agent.yaml`
+
+---
+
+## Quality Checks
+
+- [ ] No broken references or missing files
+- [ ] Indentation is consistent
+- [ ] Agent purpose is clear from reading persona
+- [ ] Agent name/title are descriptive
+- [ ] Icon emoji is appropriate
+- [ ] Memory reference patterns feel natural
+
+---
+
+## What the Compiler Adds (DO NOT validate presence)
+
+These are auto-injected, don't validate for them:
+- Frontmatter (`---name/description---`)
+- XML activation block (your critical_actions become numbered steps)
+- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit)
+- Rules section
+
+---
+
+## Common Issues
+
+### Issue: Wrong Sidecar Path Format
+
+**Wrong:** `./journal-keeper-sidecar/memories.md`
+
+**Fix:** `{project-root}/_byan/_memory/journal-keeper-sidecar/memories.md`
+
+### Issue: Missing critical_actions
+
+**Fix:** Add at minimum:
+```yaml
+critical_actions:
+  - 'Load COMPLETE file {project-root}/_byan/_memory/{sidecar-folder}/memories.md'
+  - 'Load COMPLETE file {project-root}/_byan/_memory/{sidecar-folder}/instructions.md'
+  - 'ONLY read/write files in {project-root}/_byan/_memory/{sidecar-folder}/'
+```
+
+### Issue: Communication Style Missing Memory References
+
+**Fix:** Add memory reference patterns: "I reference past naturally: 'Last time you mentioned...'"

package/install/templates/_byan/bmb/workflows/agent/data/module-agent-validation.md

@@ -0,0 +1,126 @@
+# Module Agent Validation Checklist
+
+Validate Module agents meet BMAD quality standards.
+
+**Run this AFTER Simple or Expert validation.**
+
+---
+
+## Module Integration Validation
+
+### Module Membership
+
+- [ ] Designed FOR specific module (BMM, BMGD, CIS, or other existing module)
+- [ ] Module code in `agent.metadata.module` matches target module
+- [ ] Agent integrates with module's existing agents/workflows
+
+### Workflow Integration
+
+- [ ] Menu items reference module workflows via `exec:`
+- [ ] Workflow paths are correct and exist
+- [ ] Workflow paths use: `{project-root}/_byan/{module-code}/workflows/...`
+- [ ] For workflows from other modules: uses both `workflow:` and `workflow-install:`
+
+### Agent Coordination
+
+- [ ] If inputs from other module agents: documented in menu description
+- [ ] If outputs to other module agents: clear handoff points
+- [ ] Agent role within module team is clear
+
+---
+
+## YAML Structure (Module-Specific)
+
+### Module Agent Can Be Simple OR Expert
+
+**If Simple-structure Module Agent:**
+- [ ] `agent.metadata.hasSidecar` is `false` (no sidecar)
+- [ ] Single .agent.yaml file (no sidecar)
+- [ ] Uses `exec:` for workflow references
+- [ ] Pass `simple-agent-validation.md` first
+
+**If Expert-structure Module Agent:**
+- [ ] `agent.metadata.hasSidecar` is `true` (has sidecar)
+- [ ] Has sidecar folder
+- [ ] Uses `exec:` for workflow references
+- [ ] Sidecar paths use `{project-root}/_byan/_memory/{sidecar-folder}/` format
+- [ ] Pass `expert-agent-validation.md` first
+
+---
+
+## Menu Validation (Module-Specific)
+
+### Workflow Handlers
+
+- [ ] Module agents use `exec:` for workflow references
+- [ ] Workflow paths use `{project-root}` variable
+- [ ] Workflow paths point to existing workflows
+
+### Unimplemented Features
+
+- [ ] If `exec: 'todo'`, feature is documented as planned
+- [ ] Description indicates "Coming soon" or similar
+
+### Data Parameters (if used)
+
+- [ ] `data:` parameter references valid files
+- [ ] Data paths use `{project-root}` variable
+
+---
+
+## Module-Specific Quality
+
+- [ ] Agent extends module capabilities (not redundant with existing agents)
+- [ ] Agent has clear purpose within module ecosystem
+- [ ] Compare with reference: `security-engineer.agent.yaml` (BMM module example)
+
+---
+
+## Workflow Path Validation
+
+### Module Workflow Paths
+
+- [ ] Format: `{project-root}/_byan/{module-code}/workflows/{workflow-name}/workflow.{md|yaml}`
+- [ ] Module codes: `bmm`, `bmgd`, `cis`, or custom module
+- [ ] Paths are case-sensitive and match actual file structure
+
+### Core Workflow Paths
+
+- [ ] Format: `{project-root}/_byan/core/workflows/{workflow-name}/workflow.{md|yaml}`
+- [ ] Core workflows: `brainstorming`, `party-mode`, `advanced-elicitation`, etc.
+
+---
+
+## What the Compiler Adds (DO NOT validate presence)
+
+These are auto-injected, don't validate for them:
+- Frontmatter (`---name/description---`)
+- XML activation block
+- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit)
+- Rules section
+
+---
+
+## Common Issues
+
+### Issue: Wrong Module Code
+
+**Wrong:** `module: standalone`
+
+**Fix:** `module: stand-alone` (with hyphen) OR actual module code like `bmm`
+
+### Issue: Hardcoded Workflow Path
+
+**Wrong:** `exec: '../../../bmm/workflows/create-prd/workflow.md'`
+
+**Fix:** `exec: '{project-root}/_byan/bmm/workflows/create-prd/workflow.md'`
+
+### Issue: Action Instead of Exec for Workflows
+
+**Wrong:** `action: '{project-root}/_byan/.../workflow.md'`
+
+**Fix:** `exec: '{project-root}/_byan/.../workflow.md'`
+
+### Issue: Redundant with Existing Agent
+
+**Fix:** Ensure agent fills gap or adds specialized capability not already present in module