convoke-agents 2.4.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/INSTALLATION.md +109 -86
  3. package/README.md +220 -163
  4. package/UPDATE-GUIDE.md +63 -23
  5. package/_bmad/bme/_gyre/README.md +100 -0
  6. package/_bmad/bme/_gyre/agents/.gitkeep +0 -0
  7. package/_bmad/bme/_gyre/agents/model-curator.md +128 -0
  8. package/_bmad/bme/_gyre/agents/readiness-analyst.md +127 -0
  9. package/_bmad/bme/_gyre/agents/review-coach.md +130 -0
  10. package/_bmad/bme/_gyre/agents/stack-detective.md +125 -0
  11. package/_bmad/bme/_gyre/compass-routing-reference.md +168 -0
  12. package/_bmad/bme/_gyre/config.yaml +22 -0
  13. package/_bmad/bme/_gyre/contracts/.gitkeep +0 -0
  14. package/_bmad/bme/_gyre/contracts/gc1-stack-profile.md +152 -0
  15. package/_bmad/bme/_gyre/contracts/gc2-capabilities-manifest.md +189 -0
  16. package/_bmad/bme/_gyre/contracts/gc3-findings-report.md +197 -0
  17. package/_bmad/bme/_gyre/contracts/gc4-feedback-loop.md +209 -0
  18. package/_bmad/bme/_gyre/guides/ATLAS-USER-GUIDE.md +177 -0
  19. package/_bmad/bme/_gyre/guides/COACH-USER-GUIDE.md +172 -0
  20. package/_bmad/bme/_gyre/guides/LENS-USER-GUIDE.md +181 -0
  21. package/_bmad/bme/_gyre/guides/SCOUT-USER-GUIDE.md +158 -0
  22. package/_bmad/bme/_gyre/workflows/.gitkeep +0 -0
  23. package/_bmad/bme/_gyre/workflows/accuracy-validation/steps/step-01-select-repos.md +55 -0
  24. package/_bmad/bme/_gyre/workflows/accuracy-validation/steps/step-02-run-validation.md +78 -0
  25. package/_bmad/bme/_gyre/workflows/accuracy-validation/steps/step-03-score-results.md +143 -0
  26. package/_bmad/bme/_gyre/workflows/accuracy-validation/workflow.md +41 -0
  27. package/_bmad/bme/_gyre/workflows/delta-report/steps/step-01-load-history.md +63 -0
  28. package/_bmad/bme/_gyre/workflows/delta-report/steps/step-02-compute-delta.md +72 -0
  29. package/_bmad/bme/_gyre/workflows/delta-report/steps/step-03-present-delta.md +143 -0
  30. package/_bmad/bme/_gyre/workflows/delta-report/workflow.md +34 -0
  31. package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-01-initialize.md +68 -0
  32. package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-02-detect-stack.md +49 -0
  33. package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-03-generate-model.md +52 -0
  34. package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-04-analyze-gaps.md +42 -0
  35. package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-05-review-findings.md +128 -0
  36. package/_bmad/bme/_gyre/workflows/full-analysis/workflow.md +39 -0
  37. package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-01-load-manifest.md +70 -0
  38. package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-02-observability-analysis.md +110 -0
  39. package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-03-deployment-analysis.md +87 -0
  40. package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-04-cross-domain-correlation.md +105 -0
  41. package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-05-present-findings.md +172 -0
  42. package/_bmad/bme/_gyre/workflows/gap-analysis/workflow.md +38 -0
  43. package/_bmad/bme/_gyre/workflows/model-generation/steps/step-01-load-profile.md +74 -0
  44. package/_bmad/bme/_gyre/workflows/model-generation/steps/step-02-generate-capabilities.md +116 -0
  45. package/_bmad/bme/_gyre/workflows/model-generation/steps/step-03-web-enrichment.md +89 -0
  46. package/_bmad/bme/_gyre/workflows/model-generation/steps/step-04-write-manifest.md +122 -0
  47. package/_bmad/bme/_gyre/workflows/model-generation/workflow.md +40 -0
  48. package/_bmad/bme/_gyre/workflows/model-review/steps/step-01-load-context.md +86 -0
  49. package/_bmad/bme/_gyre/workflows/model-review/steps/step-02-walkthrough.md +116 -0
  50. package/_bmad/bme/_gyre/workflows/model-review/steps/step-03-apply-amendments.md +92 -0
  51. package/_bmad/bme/_gyre/workflows/model-review/steps/step-04-capture-feedback.md +107 -0
  52. package/_bmad/bme/_gyre/workflows/model-review/steps/step-05-summary.md +60 -0
  53. package/_bmad/bme/_gyre/workflows/model-review/workflow.md +41 -0
  54. package/_bmad/bme/_gyre/workflows/stack-detection/steps/step-01-scan-filesystem.md +176 -0
  55. package/_bmad/bme/_gyre/workflows/stack-detection/steps/step-02-classify-stack.md +111 -0
  56. package/_bmad/bme/_gyre/workflows/stack-detection/steps/step-03-guard-questions.md +117 -0
  57. package/_bmad/bme/_gyre/workflows/stack-detection/workflow.md +42 -0
  58. package/_bmad/bme/_vortex/config.yaml +1 -1
  59. package/package.json +5 -2
  60. package/scripts/archive.js +304 -0
  61. package/scripts/convoke-doctor.js +146 -132
  62. package/scripts/docs-audit.js +21 -5
  63. package/scripts/install-gyre-agents.js +140 -0
  64. package/scripts/install-vortex-agents.js +0 -0
  65. package/scripts/update/lib/agent-registry.js +70 -0
  66. package/scripts/update/lib/refresh-installation.js +152 -30
  67. package/scripts/update/lib/validator.js +160 -1
@@ -0,0 +1,177 @@
1
+ # Atlas 📐 User Guide
2
+
3
+ **(model-curator.md)**
4
+
5
+ - **Version:** 1.0.0
6
+ - **Module:** Gyre Pattern (Production Readiness)
7
+ - **Last Updated:** 2026-03-24
8
+
9
+ ---
10
+
11
+ ## Quick Start
12
+
13
+ **Who is Atlas?** Atlas is a knowledgeable curator who generates a capabilities manifest unique to your project's detected tech stack. Atlas combines industry standards (DORA, OpenTelemetry, Google PRR), current best practices from web research, and your guard question answers to build a model of what production readiness looks like *for your specific project* — not a generic checklist.
14
+
15
+ **When to use Atlas:**
16
+
17
+ - Scout has produced a Stack Profile and you need a capabilities model
18
+ - You want to regenerate the model after amending it through Coach
19
+ - You need to validate model accuracy against a known stack
20
+
21
+ **Atlas vs Other Gyre Agents:**
22
+
23
+ | If you want to... | Use... |
24
+ |---|---|
25
+ | Know what tech stack a project uses | **Scout** 🔎 |
26
+ | Generate a capabilities model for that stack | **Atlas** 📐 |
27
+ | Find what's missing from the project | **Lens** 🔬 |
28
+ | Review and refine the findings | **Coach** 🏋️ |
29
+
30
+ **What you'll get:** A Capabilities Manifest (`.gyre/capabilities.yaml`) with 20+ capabilities across observability, deployment, reliability, and security domains — each with a plain-language description.
31
+
32
+ ---
33
+
34
+ ## How to Invoke
35
+
36
+ **Claude Code (skills) — recommended:**
37
+
38
+ ```
39
+ /bmad-agent-bme-model-curator
40
+ ```
41
+
42
+ **Claude Code (terminal) / Other AI assistants:**
43
+
44
+ ```bash
45
+ cat _bmad/bme/_gyre/agents/model-curator.md
46
+ ```
47
+
48
+ **Claude.ai:**
49
+
50
+ Open `_bmad/bme/_gyre/agents/model-curator.md` and paste its contents into your conversation.
51
+
52
+ ---
53
+
54
+ ## Menu Options
55
+
56
+ | # | Code | Description |
57
+ |---|------|-------------|
58
+ | 1 | **MH** | Redisplay Menu Help |
59
+ | 2 | **CH** | Chat with Atlas about capabilities and models |
60
+ | 3 | **GM** | Generate Model — build a capabilities manifest from the Stack Profile |
61
+ | 4 | **AV** | Accuracy Validation — validate model quality against test repos |
62
+ | 5 | **FA** | Full Analysis — run the complete Gyre pipeline |
63
+ | 6 | **PM** | Start Party Mode |
64
+ | 7 | **DA** | Dismiss Agent |
65
+
66
+ Select by number, code, or fuzzy text match.
67
+
68
+ ---
69
+
70
+ ## Workflows
71
+
72
+ ### [GM] Generate Model
73
+
74
+ Loads the Stack Profile (GC1) and generates a contextual capabilities manifest tailored to your project's tech stack.
75
+
76
+ - **Prerequisite:** `.gyre/stack-profile.yaml` must exist (run Scout first)
77
+ - **Output:** `.gyre/capabilities.yaml` (GC2 contract)
78
+ - **When to use:** After stack detection, or when regenerating the model
79
+
80
+ **How Atlas generates capabilities:**
81
+
82
+ 1. **Load profile** — reads Stack Profile and checks for existing amendments from Coach (GC4)
83
+ 2. **Generate capabilities** — uses stack context + industry standards (DORA metrics, OpenTelemetry, Google PRR) to produce domain-specific capabilities
84
+ 3. **Web enrichment** — searches for current best practices relevant to your stack
85
+ 4. **Write manifest** — produces the final capabilities.yaml
86
+
87
+ **Capability domains:** observability (6-10 capabilities), deployment (5-8), reliability (4-6), security (3-5).
88
+
89
+ **Capability sources:**
90
+
91
+ - **standard** — derived from industry standards (DORA, OTel, PRR)
92
+ - **practice** — discovered via web search for current best practices
93
+ - **reasoning** — inferred from stack context by Atlas
94
+
95
+ **Limited coverage warning:** If fewer than 20 capabilities are generated, Atlas surfaces a warning and offers you the choice to continue or abort.
96
+
97
+ **Amendment respect:** When regenerating, Atlas preserves your previous Coach amendments — removed capabilities stay removed, edited descriptions stay edited.
98
+
99
+ ### [AV] Accuracy Validation
100
+
101
+ Validates model quality by scoring capabilities against synthetic ground truth across multiple stack archetypes.
102
+
103
+ - **Output:** Accuracy report with per-archetype scores
104
+ - **When to use:** Quality gate before trusting the model for gap analysis
105
+
106
+ **Scoring:**
107
+
108
+ - 1.0 = Relevant (appropriate for this stack)
109
+ - 0.5 = Partially relevant (tangential or poorly described)
110
+ - 0.0 = Irrelevant (no relation to stack)
111
+
112
+ **Gate:** Must achieve ≥70% accuracy across ≥3 stack archetypes. If any archetype falls below 70%, Atlas iterates.
113
+
114
+ ### [FA] Full Analysis
115
+
116
+ Same as Scout's Full Analysis — runs the complete pipeline. Atlas handles step 3 (model generation).
117
+
118
+ ---
119
+
120
+ ## Philosophy
121
+
122
+ - **Context over generic** — Every capability is relevant to *this* stack. Atlas doesn't dump a universal checklist; it reasons about what matters for Node.js on Kubernetes differently than Python on ECS.
123
+ - **Standards inform, they don't dictate** — DORA and OpenTelemetry are starting points, not requirements. Atlas adapts to your project's actual architecture.
124
+ - **Transparency** — Each capability shows its source (standard, practice, or reasoning) so you know where it came from and can judge accordingly.
125
+ - **Team ownership** — The capabilities manifest belongs to your team. Amendments persist. The model improves with use.
126
+
127
+ ---
128
+
129
+ ## Chat with Atlas
130
+
131
+ Use **[CH]** to discuss model generation topics:
132
+
133
+ - "Why did you include distributed tracing for my project?"
134
+ - "What DORA metrics are relevant to my stack?"
135
+ - "Can you explain the difference between standard and practice sources?"
136
+ - "My project is a CLI tool, not a web service — should I regenerate?"
137
+
138
+ ---
139
+
140
+ ## Troubleshooting
141
+
142
+ **"GC1 not found" error**
143
+
144
+ Atlas requires a Stack Profile to generate the model. Run Scout's **[DS]** workflow first, then return to Atlas.
145
+
146
+ **Model seems too generic**
147
+
148
+ Check that Scout's guard answers are accurate — Atlas uses them to tune the model. If guard answers are wrong or missing, re-run Scout's **[DS]** with corrected answers, then regenerate.
149
+
150
+ **Fewer than 20 capabilities generated**
151
+
152
+ Atlas surfaces a limited-coverage warning. This can happen with unusual or very simple stacks. You can continue (the model is still useful) or abort and check if Scout's stack classification is accurate.
153
+
154
+ **Amendments disappeared after regeneration**
155
+
156
+ Atlas reads GC4 (Coach amendments) before regenerating. If amendments are missing, check that `.gyre/capabilities.yaml` contains the `amended` and `removed` flags from your last Coach review.
157
+
158
+ ---
159
+
160
+ ## Tips
161
+
162
+ - **Don't skip Scout.** Atlas needs the Stack Profile as input. Running Atlas without it produces an error, not a generic model.
163
+ - **Web search results are fresh.** Atlas searches for current-year best practices every time — no stale caches. This means models improve naturally over time.
164
+ - **Regeneration preserves your work.** Coach amendments survive regeneration. You don't lose your customizations when the model updates.
165
+ - **Capabilities.yaml IS the cache.** In anticipation mode, Atlas's model is reused rather than regenerated. This is by design — the model is stable until you explicitly regenerate.
166
+
167
+ ---
168
+
169
+ ## Credits
170
+
171
+ - **Agent:** Atlas (Model Curator)
172
+ - **Module:** Gyre Pattern v1.0.0
173
+ - **Pattern:** Convoke Agent Architecture
174
+
175
+ ---
176
+
177
+ *Scout finds the facts. Atlas builds the model. Lens finds the gaps. Coach helps you act on them.*
@@ -0,0 +1,172 @@
1
+ # Coach 🏋️ User Guide
2
+
3
+ **(review-coach.md)**
4
+
5
+ - **Version:** 1.0.0
6
+ - **Module:** Gyre Pattern (Production Readiness)
7
+ - **Last Updated:** 2026-03-24
8
+
9
+ ---
10
+
11
+ ## Quick Start
12
+
13
+ **Who is Coach?** Coach is a patient guide who walks you through your capabilities model and findings. Coach never pushes — it presents options and respects your expertise. Through conversational review, you can amend capabilities, adjust findings, and capture feedback that improves the model for your entire team.
14
+
15
+ **When to use Coach:**
16
+
17
+ - Lens has produced findings and you want to review them
18
+ - You want to customize the capabilities model (remove irrelevant capabilities, add missing ones)
19
+ - You want to capture feedback about gaps Gyre missed
20
+
21
+ **Coach vs Other Gyre Agents:**
22
+
23
+ | If you want to... | Use... |
24
+ |---|---|
25
+ | Know what tech stack a project uses | **Scout** 🔎 |
26
+ | Generate a capabilities model for that stack | **Atlas** 📐 |
27
+ | Find what's missing from the project | **Lens** 🔬 |
28
+ | Review and refine the findings | **Coach** 🏋️ |
29
+
30
+ **What you'll get:** An amended capabilities manifest, reviewed findings, and feedback captured in `.gyre/feedback.yaml` — all persisted for future runs.
31
+
32
+ ---
33
+
34
+ ## How to Invoke
35
+
36
+ **Claude Code (skills) — recommended:**
37
+
38
+ ```
39
+ /bmad-agent-bme-review-coach
40
+ ```
41
+
42
+ **Claude Code (terminal) / Other AI assistants:**
43
+
44
+ ```bash
45
+ cat _bmad/bme/_gyre/agents/review-coach.md
46
+ ```
47
+
48
+ **Claude.ai:**
49
+
50
+ Open `_bmad/bme/_gyre/agents/review-coach.md` and paste its contents into your conversation.
51
+
52
+ ---
53
+
54
+ ## Menu Options
55
+
56
+ | # | Code | Description |
57
+ |---|------|-------------|
58
+ | 1 | **MH** | Redisplay Menu Help |
59
+ | 2 | **CH** | Chat with Coach about findings and customization |
60
+ | 3 | **RF** | Review Findings — walk through Lens's findings |
61
+ | 4 | **RM** | Review Model — walk through Atlas's capabilities |
62
+ | 5 | **FA** | Full Analysis — run the complete Gyre pipeline |
63
+ | 6 | **PM** | Start Party Mode |
64
+ | 7 | **DA** | Dismiss Agent |
65
+
66
+ Select by number, code, or fuzzy text match.
67
+
68
+ ---
69
+
70
+ ## Workflows
71
+
72
+ ### [RF] Review Findings
73
+
74
+ Walk through Lens's findings severity-first — blockers, then recommended, then nice-to-have. Amend capabilities and capture feedback.
75
+
76
+ ### [RM] Review Model
77
+
78
+ Walk through Atlas's capabilities manifest — keep, remove, edit, or add capabilities to tailor the model to your project.
79
+
80
+ Both RF and RM invoke the same model-review workflow. Coach asks which mode you want, or you can do both in sequence.
81
+
82
+ - **Prerequisite:** `.gyre/capabilities.yaml` (GC2) required; `.gyre/findings.yaml` (GC3) required for findings review
83
+ - **Output:** Amended capabilities.yaml + `.gyre/feedback.yaml` (GC4 contract)
84
+ - **When to use:** After Lens produces findings, or any time you want to refine the model
85
+
86
+ **Review flow:**
87
+
88
+ 1. **Load context** — reads artifacts, displays any existing feedback, checks for deferred reviews
89
+ 2. **Walkthrough** — walks through each capability or finding. For each item: keep, remove, edit, or add new
90
+ 3. **Apply amendments** — writes changes directly to capabilities.yaml with amendment flags (`amended`, `removed`, timestamps)
91
+ 4. **Capture feedback** — prompts "Did Gyre miss anything you know about?" Persists responses to `.gyre/feedback.yaml` with timestamp
92
+ 5. **Summary** — presents review summary and Compass routing to next agent
93
+
94
+ **Findings are presented severity-first:** blockers, then recommended, then nice-to-have. You see the most critical items first.
95
+
96
+ **Amendment types:**
97
+
98
+ | Action | What happens |
99
+ |---|---|
100
+ | **Keep** | Capability unchanged |
101
+ | **Remove** | Capability flagged `removed: true` with timestamp. Excluded from future analysis. |
102
+ | **Edit** | Description or category updated. Original values preserved with `amended: true`. |
103
+ | **Add** | New capability added with `source: user-added`. Included in future analysis. |
104
+
105
+ **Feedback types:** missed-capability, missed-gap, severity-adjustment, other.
106
+
107
+ **Team benefit:** Coach explains that `feedback.yaml` should be committed to your repo. When teammates run Gyre, their analysis benefits from your amendments and feedback.
108
+
109
+ ### [FA] Full Analysis
110
+
111
+ Same as Scout's Full Analysis — runs the complete pipeline. Coach handles step 5 (review).
112
+
113
+ ---
114
+
115
+ ## Philosophy
116
+
117
+ - **Your expertise wins** — Coach presents information and options. It never argues that you should keep a capability you want to remove. You know your project better than any model.
118
+ - **Non-destructive amendments** — Removals are flags, not deletions. Original values are preserved. Nothing is lost, and amendments can be reversed.
119
+ - **Feedback compounds** — Every review makes the model better for the next person. Feedback persists across runs and across team members.
120
+ - **Deferral is fine** — If you're not ready to review, Coach records a "review deferred" flag and reminds you on the next run. No pressure.
121
+
122
+ ---
123
+
124
+ ## Chat with Coach
125
+
126
+ Use **[CH]** to discuss review topics:
127
+
128
+ - "Should I remove capabilities that my project doesn't need yet?"
129
+ - "How do amendments affect future Gyre runs?"
130
+ - "What happens to my feedback when Atlas regenerates the model?"
131
+ - "Can my team members see and build on my amendments?"
132
+
133
+ ---
134
+
135
+ ## Troubleshooting
136
+
137
+ **"GC2 not found" or "GC3 not found" error**
138
+
139
+ Coach needs the capabilities manifest for model review and the findings report for findings review. Run Atlas and/or Lens first, then return to Coach.
140
+
141
+ **I accidentally removed a capability I need**
142
+
143
+ Amendments are flags, not deletions. The original capability is still in capabilities.yaml with `removed: true`. Edit the YAML directly to remove the flag, or ask Coach to re-add it.
144
+
145
+ **Feedback not showing on next run**
146
+
147
+ Coach displays existing feedback at the start of each review. Check that `.gyre/feedback.yaml` exists and was committed to your repo if working across branches.
148
+
149
+ **Review feels overwhelming**
150
+
151
+ You don't have to review everything in one session. Coach supports deferral — stop when you need to and resume later. Blockers-first ordering means you always see the most important items first.
152
+
153
+ ---
154
+
155
+ ## Tips
156
+
157
+ - **Review findings before the model.** Findings give you context about which capabilities matter for your project. Reviewing the model cold is harder.
158
+ - **Commit `.gyre/feedback.yaml` to your repo.** This is how your team shares Gyre improvements. Feedback from one person's review benefits everyone.
159
+ - **Use "missed-gap" feedback liberally.** If you know about a gap Gyre didn't catch, tell Coach. This is the primary mechanism for model improvement.
160
+ - **Amendments persist through regeneration.** When Atlas rebuilds the model, your removals and edits are preserved. Don't worry about losing your customizations.
161
+
162
+ ---
163
+
164
+ ## Credits
165
+
166
+ - **Agent:** Coach (Review Coach)
167
+ - **Module:** Gyre Pattern v1.0.0
168
+ - **Pattern:** Convoke Agent Architecture
169
+
170
+ ---
171
+
172
+ *Scout finds the facts. Atlas builds the model. Lens finds the gaps. Coach helps you act on them.*
@@ -0,0 +1,181 @@
1
+ # Lens 🔬 User Guide
2
+
3
+ **(readiness-analyst.md)**
4
+
5
+ - **Version:** 1.0.0
6
+ - **Module:** Gyre Pattern (Production Readiness)
7
+ - **Last Updated:** 2026-03-24
8
+
9
+ ---
10
+
11
+ ## Quick Start
12
+
13
+ **Who is Lens?** Lens is a thorough analyst who compares your capabilities manifest against what actually exists in your project. Lens detects *absences* — capabilities that should be present for your stack but aren't — and surfaces cross-domain patterns where gaps compound each other's risk.
14
+
15
+ **When to use Lens:**
16
+
17
+ - Atlas has generated a capabilities model and you want to find gaps
18
+ - You've made changes to your project and want to see what's improved (delta report)
19
+ - You need a severity-prioritized view of what's missing
20
+
21
+ **Lens vs Other Gyre Agents:**
22
+
23
+ | If you want to... | Use... |
24
+ |---|---|
25
+ | Know what tech stack a project uses | **Scout** 🔎 |
26
+ | Generate a capabilities model for that stack | **Atlas** 📐 |
27
+ | Find what's missing from the project | **Lens** 🔬 |
28
+ | Review and refine the findings | **Coach** 🏋️ |
29
+
30
+ **What you'll get:** A Findings Report (`.gyre/findings.yaml`) with absence-based findings tagged by severity, confidence, and source — plus cross-domain compound findings that show how gaps amplify each other.
31
+
32
+ ---
33
+
34
+ ## How to Invoke
35
+
36
+ **Claude Code (skills) — recommended:**
37
+
38
+ ```
39
+ /bmad-agent-bme-readiness-analyst
40
+ ```
41
+
42
+ **Claude Code (terminal) / Other AI assistants:**
43
+
44
+ ```bash
45
+ cat _bmad/bme/_gyre/agents/readiness-analyst.md
46
+ ```
47
+
48
+ **Claude.ai:**
49
+
50
+ Open `_bmad/bme/_gyre/agents/readiness-analyst.md` and paste its contents into your conversation.
51
+
52
+ ---
53
+
54
+ ## Menu Options
55
+
56
+ | # | Code | Description |
57
+ |---|------|-------------|
58
+ | 1 | **MH** | Redisplay Menu Help |
59
+ | 2 | **CH** | Chat with Lens about analysis and findings |
60
+ | 3 | **AG** | Analyze Gaps — compare capabilities against what exists |
61
+ | 4 | **DR** | Delta Report — track progress between analysis runs |
62
+ | 5 | **FA** | Full Analysis — run the complete Gyre pipeline |
63
+ | 6 | **PM** | Start Party Mode |
64
+ | 7 | **DA** | Dismiss Agent |
65
+
66
+ Select by number, code, or fuzzy text match.
67
+
68
+ ---
69
+
70
+ ## Workflows
71
+
72
+ ### [AG] Analyze Gaps
73
+
74
+ Loads the Capabilities Manifest (GC2) and searches the project filesystem for evidence of each capability. Produces a severity-prioritized findings report.
75
+
76
+ - **Prerequisite:** `.gyre/capabilities.yaml` must exist (run Atlas first)
77
+ - **Output:** `.gyre/findings.yaml` (GC3 contract)
78
+ - **When to use:** After model generation, or after significant project changes
79
+
80
+ **How Lens analyzes:**
81
+
82
+ 1. **Load manifest** — reads the capabilities model
83
+ 2. **Observability analysis** — searches for observability evidence (logging, metrics, tracing, alerting)
84
+ 3. **Deployment analysis** — searches for deployment evidence (CI/CD, containerization, environment config, rollback)
85
+ 4. **Cross-domain correlation** — identifies compound patterns where gaps in different domains amplify each other
86
+ 5. **Present findings** — severity-first summary with blockers, recommended, and nice-to-have counts
87
+
88
+ **Finding tags:**
89
+
90
+ | Tag | Meaning |
91
+ |---|---|
92
+ | **Severity** | blocker / recommended / nice-to-have |
93
+ | **Source** | static-analysis (file evidence) or contextual-model (inferred from model) |
94
+ | **Confidence** | high / medium / low |
95
+
96
+ Each finding includes a brief rationale for its severity classification.
97
+
98
+ **Compound findings:** Lens identifies cross-domain patterns — for example, "no health checks" + "no deployment rollback" is a compound risk where each gap makes the other more dangerous. Compound findings are suppressed when either component has low confidence.
99
+
100
+ **Novelty ratio:** Lens reports what proportion of findings come from the contextual model vs static analysis ("X of Y findings are contextual"), so you know how much of the analysis is evidence-based vs model-driven.
101
+
102
+ ### [DR] Delta Report
103
+
104
+ Compares current findings against a previous analysis run to show what changed.
105
+
106
+ - **Prerequisite:** `.gyre/findings.yaml` must exist from a previous run
107
+ - **Output:** Delta analysis with change tags
108
+ - **When to use:** After making improvements, to track progress
109
+
110
+ **Delta tags:**
111
+
112
+ - **[NEW]** — Finding appeared since last run
113
+ - **[CARRIED]** — Finding persists from previous run
114
+ - **Resolved** — Finding from previous run no longer present (you fixed it)
115
+
116
+ On first run, all findings are tagged [NEW] and saved as the baseline for future comparisons.
117
+
118
+ ### [FA] Full Analysis
119
+
120
+ Same as Scout's Full Analysis — runs the complete pipeline. Lens handles step 4 (gap analysis).
121
+
122
+ ---
123
+
124
+ ## Philosophy
125
+
126
+ - **Absences, not misconfigurations** — Lens looks for what's missing, not what's wrong with what exists. A missing health check is a finding; a misconfigured health check is not Gyre's scope.
127
+ - **Evidence-based honesty** — Every finding shows its source and confidence level. Lens doesn't inflate severity to look thorough.
128
+ - **Compound thinking** — Individual gaps are important, but gaps that amplify each other are critical. Lens surfaces these relationships explicitly.
129
+ - **Progress, not perfection** — The delta report exists because production readiness is a journey. Tracking resolved findings is as important as finding new ones.
130
+
131
+ ---
132
+
133
+ ## Chat with Lens
134
+
135
+ Use **[CH]** to discuss analysis topics:
136
+
137
+ - "Why is this finding marked as a blocker?"
138
+ - "What evidence would you need to see to resolve this finding?"
139
+ - "Can you explain the compound relationship between these two gaps?"
140
+ - "My project is internal-only — should security findings still be blockers?"
141
+
142
+ ---
143
+
144
+ ## Troubleshooting
145
+
146
+ **"GC2 not found" error**
147
+
148
+ Lens requires a Capabilities Manifest. Run Atlas's **[GM]** workflow first, then return to Lens.
149
+
150
+ **Too many findings, hard to prioritize**
151
+
152
+ Start with blockers only — these are the gaps with the highest risk. Use Coach to review and potentially downgrade findings that aren't relevant to your context.
153
+
154
+ **Delta report shows all [NEW]**
155
+
156
+ This is expected on the first run. The current findings become the baseline. Run **[DR]** again after your next analysis to see meaningful deltas.
157
+
158
+ **Findings seem wrong for my project**
159
+
160
+ The findings depend on Atlas's capabilities model. If the model includes irrelevant capabilities, use Coach to remove them. Lens will exclude removed capabilities on re-analysis.
161
+
162
+ ---
163
+
164
+ ## Tips
165
+
166
+ - **Read the severity rationale.** Lens provides a brief explanation for every severity classification. If you disagree, Coach lets you adjust.
167
+ - **Compound findings are your highest-value signal.** They reveal systemic gaps that individual findings miss. Pay attention to these.
168
+ - **Run delta reports after sprints.** Tracking resolved findings over time gives leadership visibility into readiness progress.
169
+ - **The novelty ratio tells you how much to trust.** A high contextual ratio means the model is doing more inference and less evidence-finding. Consider whether the model needs refining through Coach.
170
+
171
+ ---
172
+
173
+ ## Credits
174
+
175
+ - **Agent:** Lens (Readiness Analyst)
176
+ - **Module:** Gyre Pattern v1.0.0
177
+ - **Pattern:** Convoke Agent Architecture
178
+
179
+ ---
180
+
181
+ *Scout finds the facts. Atlas builds the model. Lens finds the gaps. Coach helps you act on them.*
@@ -0,0 +1,158 @@
1
+ # Scout 🔎 User Guide
2
+
3
+ **(stack-detective.md)**
4
+
5
+ - **Version:** 1.0.0
6
+ - **Module:** Gyre Pattern (Production Readiness)
7
+ - **Last Updated:** 2026-03-24
8
+
9
+ ---
10
+
11
+ ## Quick Start
12
+
13
+ **Who is Scout?** Scout is a methodical investigator who detects your project's technology stack by analyzing filesystem artifacts — package manifests, config files, IaC templates, CI/CD definitions. Scout builds a structured profile of what your project actually uses, not what someone documented months ago.
14
+
15
+ **When to use Scout:**
16
+
17
+ - You're starting a Gyre analysis on a new project
18
+ - You need a structured inventory of a project's tech stack
19
+ - You want to confirm or correct assumptions about what technologies are in use
20
+
21
+ **Scout vs Other Gyre Agents:**
22
+
23
+ | If you want to... | Use... |
24
+ |---|---|
25
+ | Know what tech stack a project uses | **Scout** 🔎 |
26
+ | Generate a capabilities model for that stack | **Atlas** 📐 |
27
+ | Find what's missing from the project | **Lens** 🔬 |
28
+ | Review and refine the findings | **Coach** 🏋️ |
29
+
30
+ **What you'll get:** A Stack Profile (`.gyre/stack-profile.yaml`) covering primary language/framework, container orchestration, CI/CD platform, observability tooling, cloud provider, and communication protocols.
31
+
32
+ ---
33
+
34
+ ## How to Invoke
35
+
36
+ **Claude Code (skills) — recommended:**
37
+
38
+ ```
39
+ /bmad-agent-bme-stack-detective
40
+ ```
41
+
42
+ **Claude Code (terminal) / Other AI assistants:**
43
+
44
+ ```bash
45
+ cat _bmad/bme/_gyre/agents/stack-detective.md
46
+ ```
47
+
48
+ **Claude.ai:**
49
+
50
+ Open `_bmad/bme/_gyre/agents/stack-detective.md` and paste its contents into your conversation.
51
+
52
+ ---
53
+
54
+ ## Menu Options
55
+
56
+ | # | Code | Description |
57
+ |---|------|-------------|
58
+ | 1 | **MH** | Redisplay Menu Help |
59
+ | 2 | **CH** | Chat with Scout about stack detection |
60
+ | 3 | **DS** | Detect Stack — scan the project and build a Stack Profile |
61
+ | 4 | **FA** | Full Analysis — run the complete Gyre pipeline (Scout → Atlas → Lens → Coach) |
62
+ | 5 | **PM** | Start Party Mode |
63
+ | 6 | **DA** | Dismiss Agent |
64
+
65
+ Select by number, code, or fuzzy text match (e.g., "detect" matches DS).
66
+
67
+ ---
68
+
69
+ ## Workflows
70
+
71
+ ### [DS] Detect Stack
72
+
73
+ Scans the project filesystem for technology indicators and produces a classified Stack Profile.
74
+
75
+ - **Output:** `.gyre/stack-profile.yaml` (GC1 contract)
76
+ - **When to use:** Starting a new Gyre analysis, or re-detecting after significant project changes
77
+
78
+ **What Scout detects:**
79
+
80
+ - Primary language/framework (package.json, go.mod, requirements.txt, Cargo.toml, pom.xml)
81
+ - Container orchestration (Dockerfile, docker-compose.yaml, Kubernetes manifests, ECS task definitions)
82
+ - CI/CD platform (.github/workflows/, .gitlab-ci.yml, Jenkinsfile)
83
+ - Observability tooling (OpenTelemetry, Prometheus, Datadog configs)
84
+ - Cloud provider (Terraform, CloudFormation, Pulumi templates)
85
+ - Communication protocols (gRPC protos, REST controllers, message queues)
86
+
87
+ **Guard questions:** After detection, Scout asks up to 3 targeted questions to resolve ambiguities. If detection is unambiguous, guard questions are skipped. You can correct any answer without re-running the full scan.
88
+
89
+ **Monorepo support:** If Scout detects multiple service boundaries, it asks you to select which service to analyze.
90
+
91
+ ### [FA] Full Analysis
92
+
93
+ Orchestrates the complete Gyre pipeline across all 4 agents. Scout handles initialization and detection (steps 1-2), then hands off to Atlas, Lens, and Coach in sequence.
94
+
95
+ - **Output:** Complete `.gyre/` directory with all artifacts
96
+ - **When to use:** First time running Gyre on a project, or when you want the full end-to-end experience
97
+
98
+ **Modes:**
99
+
100
+ - **Crisis** — No `.gyre/` directory exists. Full pipeline runs from scratch.
101
+ - **Anticipation** — Previous analysis exists. Model generation is skipped (capabilities.yaml serves as cache). Only gap analysis and review run.
102
+ - **Regeneration** — You explicitly ask to regenerate. Fresh model generation replaces the cached manifest.
103
+
104
+ ---
105
+
106
+ ## Philosophy
107
+
108
+ - **Evidence over assumption** — Scout reports what it finds in the filesystem, not what it expects to find. Every classification is backed by a file reference.
109
+ - **Categories, not contents** — The Stack Profile records technology categories only. No file contents, paths, version numbers, or secrets ever enter `.gyre/` artifacts.
110
+ - **Minimal questions** — Guard questions are derived from detection gaps, not a generic questionnaire. If detection is clean, Scout doesn't waste your time.
111
+
112
+ ---
113
+
114
+ ## Chat with Scout
115
+
116
+ Use **[CH]** to discuss stack detection topics:
117
+
118
+ - "What indicators do you look for to detect Kubernetes?"
119
+ - "My project uses both Python and Go — how do you handle that?"
120
+ - "Why did you classify my project as AWS when we also use some GCP?"
121
+ - "What's the difference between crisis and anticipation mode?"
122
+
123
+ ---
124
+
125
+ ## Troubleshooting
126
+
127
+ **Scout can't find my tech stack**
128
+
129
+ Scout relies on filesystem artifacts (package manifests, config files). If your project uses non-standard locations or custom tooling, use the guard questions to correct the classification manually.
130
+
131
+ **`.gyre/` directory already exists but I want a fresh start**
132
+
133
+ Delete the `.gyre/` directory and run **[DS]** or **[FA]** again. Scout will detect crisis mode and run the full pipeline from scratch.
134
+
135
+ **Multiple stacks detected, wrong one selected as primary**
136
+
137
+ Scout surfaces secondary stacks as a warning and lets you confirm or override via guard questions. If the wrong stack was selected, correct it in the guard answer — Scout re-classifies without re-scanning.
138
+
139
+ ---
140
+
141
+ ## Tips
142
+
143
+ - **Start with Full Analysis [FA] your first time.** It orchestrates the entire pipeline so you see the complete Gyre experience. Use individual workflows once you're familiar.
144
+ - **Guard answers matter downstream.** Atlas uses your guard answers to tune the capabilities model. Accurate answers here mean more relevant findings later.
145
+ - **Re-detect after major changes.** If you add Kubernetes, switch CI providers, or adopt a new observability stack, re-run **[DS]** to update the Stack Profile before re-analyzing.
146
+ - **Privacy is built in.** Scout's Stack Profile contains technology categories only — safe to commit to your repo for team-wide use.
147
+
148
+ ---
149
+
150
+ ## Credits
151
+
152
+ - **Agent:** Scout (Stack Detective)
153
+ - **Module:** Gyre Pattern v1.0.0
154
+ - **Pattern:** Convoke Agent Architecture
155
+
156
+ ---
157
+
158
+ *Scout finds the facts. Atlas builds the model. Lens finds the gaps. Coach helps you act on them.*
File without changes