@garethdaine/agentops 0.9.0
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.
- package/.claude-plugin/plugin.json +10 -0
- package/LICENSE +21 -0
- package/README.md +410 -0
- package/agents/architecture-researcher.md +115 -0
- package/agents/code-critic.md +190 -0
- package/agents/delegation-router.md +40 -0
- package/agents/feature-researcher.md +117 -0
- package/agents/interrogator.md +11 -0
- package/agents/pitfalls-researcher.md +112 -0
- package/agents/plan-validator.md +173 -0
- package/agents/proposer.md +61 -0
- package/agents/security-reviewer.md +189 -0
- package/agents/skill-builder.md +43 -0
- package/agents/spec-compliance-reviewer.md +154 -0
- package/agents/stack-researcher.md +89 -0
- package/commands/build.md +766 -0
- package/commands/code-analysis.md +39 -0
- package/commands/code-field.md +22 -0
- package/commands/compliance-check.md +34 -0
- package/commands/configure.md +178 -0
- package/commands/cost-report.md +17 -0
- package/commands/enterprise/adr.md +78 -0
- package/commands/enterprise/brainstorm.md +461 -0
- package/commands/enterprise/design.md +203 -0
- package/commands/enterprise/dev-setup.md +136 -0
- package/commands/enterprise/docker-dev.md +229 -0
- package/commands/enterprise/e2e.md +233 -0
- package/commands/enterprise/feature.md +218 -0
- package/commands/enterprise/gap-analysis.md +204 -0
- package/commands/enterprise/handover.md +195 -0
- package/commands/enterprise/herd.md +152 -0
- package/commands/enterprise/knowledge.md +173 -0
- package/commands/enterprise/onboard.md +86 -0
- package/commands/enterprise/qa-check.md +80 -0
- package/commands/enterprise/reason.md +196 -0
- package/commands/enterprise/review.md +177 -0
- package/commands/enterprise/scaffold.md +153 -0
- package/commands/enterprise/status-report.md +101 -0
- package/commands/enterprise/tech-catalog.md +170 -0
- package/commands/enterprise/test-gen.md +138 -0
- package/commands/evolve.md +39 -0
- package/commands/flags.md +44 -0
- package/commands/interrogate.md +263 -0
- package/commands/lesson.md +15 -0
- package/commands/lessons.md +10 -0
- package/commands/plan.md +44 -0
- package/commands/prune.md +27 -0
- package/commands/star.md +17 -0
- package/commands/supply-chain-scan.md +44 -0
- package/commands/unicode-scan.md +63 -0
- package/commands/verify.md +41 -0
- package/commands/workflow.md +436 -0
- package/hooks/ai-guardrails.sh +114 -0
- package/hooks/audit-log.sh +26 -0
- package/hooks/auto-delegate.sh +45 -0
- package/hooks/auto-evolve.sh +22 -0
- package/hooks/auto-lesson.sh +26 -0
- package/hooks/auto-plan.sh +59 -0
- package/hooks/auto-test.sh +46 -0
- package/hooks/auto-verify.sh +30 -0
- package/hooks/budget-check.sh +24 -0
- package/hooks/code-field-preamble.sh +30 -0
- package/hooks/compliance-gate.sh +50 -0
- package/hooks/content-trust.sh +22 -0
- package/hooks/credential-redact.sh +23 -0
- package/hooks/delegation-trust.sh +15 -0
- package/hooks/detect-test-run.sh +19 -0
- package/hooks/enforcement-lib.sh +60 -0
- package/hooks/evolve-gate.sh +32 -0
- package/hooks/evolve-lib.sh +32 -0
- package/hooks/exfiltration-check.sh +67 -0
- package/hooks/failure-collector.sh +27 -0
- package/hooks/feature-flags.sh +67 -0
- package/hooks/file-provenance.sh +31 -0
- package/hooks/flag-utils.sh +36 -0
- package/hooks/hooks.json +145 -0
- package/hooks/injection-scan.sh +58 -0
- package/hooks/integrity-verify.sh +91 -0
- package/hooks/lessons-check.sh +17 -0
- package/hooks/lockfile-audit.sh +109 -0
- package/hooks/patterns-lib.sh +22 -0
- package/hooks/plan-gate.sh +18 -0
- package/hooks/redact-lib.sh +15 -0
- package/hooks/runtime-mode.sh +56 -0
- package/hooks/session-cleanup.sh +74 -0
- package/hooks/skill-validator.sh +28 -0
- package/hooks/standards-enforce.sh +106 -0
- package/hooks/star-gate.sh +93 -0
- package/hooks/star-preamble.sh +10 -0
- package/hooks/telemetry.sh +33 -0
- package/hooks/todo-prune.sh +84 -0
- package/hooks/unicode-firewall.sh +122 -0
- package/hooks/unicode-lib.sh +66 -0
- package/hooks/unicode-scan-session.sh +96 -0
- package/hooks/validate-command.sh +103 -0
- package/hooks/validate-env.sh +51 -0
- package/hooks/validate-path.sh +81 -0
- package/package.json +40 -0
- package/settings.json +6 -0
- package/templates/ai-config/tool-standards.md +56 -0
- package/templates/architecture/api-first.md +192 -0
- package/templates/architecture/auth-patterns.md +302 -0
- package/templates/architecture/caching-strategy.md +359 -0
- package/templates/architecture/database-patterns.md +347 -0
- package/templates/architecture/event-driven.md +252 -0
- package/templates/architecture/integration-patterns.md +185 -0
- package/templates/architecture/multi-tenancy.md +104 -0
- package/templates/architecture/service-boundaries.md +200 -0
- package/templates/build/brief-template.md +86 -0
- package/templates/build/summary-template.md +100 -0
- package/templates/build/task-plan-template.md +133 -0
- package/templates/communication/effort-estimate.md +54 -0
- package/templates/communication/incident-response.md +59 -0
- package/templates/communication/post-mortem.md +109 -0
- package/templates/communication/risk-register.md +43 -0
- package/templates/communication/sprint-demo-checklist.md +64 -0
- package/templates/communication/stakeholder-presentation-outline.md +84 -0
- package/templates/communication/technical-proposal.md +77 -0
- package/templates/delivery/deployment/deployment-checklist.md +49 -0
- package/templates/delivery/design/solution-design-checklist.md +37 -0
- package/templates/delivery/discovery/stakeholder-questions.md +33 -0
- package/templates/delivery/handover/knowledge-transfer-checklist.md +75 -0
- package/templates/delivery/handover/operational-runbook.md +117 -0
- package/templates/delivery/handover/support-escalation-matrix.md +56 -0
- package/templates/delivery/implementation/blocker-escalation-template.md +55 -0
- package/templates/delivery/implementation/sprint-planning-template.md +49 -0
- package/templates/delivery/implementation/task-decomposition-guide.md +59 -0
- package/templates/delivery/qa/test-plan-template.md +76 -0
- package/templates/delivery/qa/test-results-template.md +55 -0
- package/templates/delivery/qa/uat-signoff-template.md +44 -0
- package/templates/governance/codeowners.md +60 -0
- package/templates/integration/adapter-pattern.md +160 -0
- package/templates/scaffolds/env-validation.md +85 -0
- package/templates/scaffolds/error-handling.md +171 -0
- package/templates/scaffolds/graceful-shutdown.md +139 -0
- package/templates/scaffolds/health-check.md +109 -0
- package/templates/scaffolds/structured-logging.md +134 -0
- package/templates/standards/engineering-standards.md +413 -0
- package/templates/standards/standards-checklist.md +125 -0
- package/templates/tech-catalog.json +663 -0
- package/templates/utilities/project-detection.md +75 -0
- package/templates/utilities/requirements-collection.md +68 -0
- package/templates/utilities/template-rendering.md +81 -0
- package/templates/workflows/architecture-decision.md +90 -0
- package/templates/workflows/bug-investigation.md +83 -0
- package/templates/workflows/feature-implementation.md +80 -0
- package/templates/workflows/refactoring.md +83 -0
- package/templates/workflows/spike-exploration.md +82 -0
|
@@ -0,0 +1,461 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: brainstorm
|
|
3
|
+
description: Time-boxed brainstorming session with guided execution, verification, and completion reporting through AgentOps workflows
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are a brainstorming and execution orchestrator. You guide the engineer through a structured 7-phase workflow: session setup, rapid discovery, approach selection, plan generation, guided execution, verification, and completion reporting — all within a declared time budget.
|
|
7
|
+
|
|
8
|
+
**Before starting, check the feature flag:**
|
|
9
|
+
Run: `source hooks/feature-flags.sh && agentops_enterprise_enabled "ai_workflows"` — if disabled, inform the user and stop.
|
|
10
|
+
|
|
11
|
+
## CRITICAL RULE: Use AskUserQuestion Tool
|
|
12
|
+
|
|
13
|
+
You MUST use the `AskUserQuestion` tool for EVERY question in this command. DO NOT print questions as plain text or numbered option lists. Call the AskUserQuestion tool which renders a proper selection UI. This applies to: session setup (Phase 0), clarifying questions (Phase 1), approach selection (Phase 2), plan approval (Phase 3), time management (Phase 4), verification decisions (Phase 5), and all other user interactions. This is a BLOCKING REQUIREMENT.
|
|
14
|
+
|
|
15
|
+
**Read the autonomy level** from `.agentops/flags.json` (key: `autonomy_level`). Default to `guided` if not set.
|
|
16
|
+
- `guided` — pause at plan approval (Phase 3) and verification issues (Phase 5)
|
|
17
|
+
- `supervised` — pause after every execution step (Phase 4) in addition to guided gates
|
|
18
|
+
- `autonomous` — proceed with minimal gates (skip plan approval, skip per-step pauses; still pause on verification failures)
|
|
19
|
+
|
|
20
|
+
The user's task description is: $ARGUMENTS
|
|
21
|
+
|
|
22
|
+
If no arguments provided, Phase 0 will collect the task description via AskUserQuestion.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Phase 0: Session Setup
|
|
27
|
+
|
|
28
|
+
### Step 1: Git Repository Initialisation
|
|
29
|
+
|
|
30
|
+
Use `AskUserQuestion` to ask:
|
|
31
|
+
- question: "Would you like to initialise a git repository for this session?"
|
|
32
|
+
- header: "Git"
|
|
33
|
+
- options: [{label: "Yes — track all work with git", description: "Creates a repo (or uses existing) and auto-commits at natural breakpoints with conventional commit messages"}, {label: "No — skip git", description: "Work without version control tracking"}]
|
|
34
|
+
|
|
35
|
+
If yes: run `git init` (if not already a repo), create initial commit with message `chore: initialise brainstorming session`. Store the git preference as a session variable — all subsequent phases auto-commit when complete.
|
|
36
|
+
|
|
37
|
+
### Step 2: Task Description
|
|
38
|
+
|
|
39
|
+
If `$ARGUMENTS` is empty or not provided, use `AskUserQuestion`:
|
|
40
|
+
- question: "Describe the task or problem you're brainstorming. What are you trying to achieve?"
|
|
41
|
+
- header: "Task"
|
|
42
|
+
- options: [{label: "Let me describe it", description: "I'll type the task description"}, {label: "Read from file", description: "The task is described in a file I'll point you to"}]
|
|
43
|
+
|
|
44
|
+
Store the response verbatim as the session brief.
|
|
45
|
+
|
|
46
|
+
### Step 3: Time Budget
|
|
47
|
+
|
|
48
|
+
Use `AskUserQuestion`:
|
|
49
|
+
- question: "How many minutes do you have to complete this?"
|
|
50
|
+
- header: "Time"
|
|
51
|
+
- options: [{label: "30 minutes", description: "Rapid: brainstorm one approach, execute immediately, quick smoke test"}, {label: "60 minutes", description: "Moderate: brainstorm, plan, execute core feature, one review pass, run tests"}, {label: "90 minutes (Recommended)", description: "Full: brainstorm, structured plan, execute, test, review, completion report"}, {label: "120 minutes", description: "Deep: exploration, full plan, execute, comprehensive testing, multiple review passes"}, {label: "No time limit", description: "Full depth on every phase, no shortcuts"}]
|
|
52
|
+
|
|
53
|
+
Store the time budget. This governs phase depth:
|
|
54
|
+
|
|
55
|
+
| Budget | Discovery Qs | Approaches | Verification | Report |
|
|
56
|
+
|--------|-------------|------------|--------------|--------|
|
|
57
|
+
| 30 min | 1-2 | 2 | Smoke test only | Skip |
|
|
58
|
+
| 60 min | 3-4 | 2-3 | Run tests, one review | Brief |
|
|
59
|
+
| 90 min | 4-6 | 3-4 | Full tests + review | Full |
|
|
60
|
+
| 120 min | 5-7 | 3-4 | Full + browser + multi-pass | Full + polish |
|
|
61
|
+
| No limit | Exhaustive | 3-4 | Comprehensive | Full + polish |
|
|
62
|
+
|
|
63
|
+
### Step 4: Create Session Directory and Scratchpad
|
|
64
|
+
|
|
65
|
+
Generate a kebab-case slug from the task description (e.g., `supplier-directory-api`, `dashboard-redesign`).
|
|
66
|
+
|
|
67
|
+
Create `./docs/brainstorming/{session-name}/scratchpad.md`:
|
|
68
|
+
|
|
69
|
+
```markdown
|
|
70
|
+
# Brainstorming Session: {session-name}
|
|
71
|
+
|
|
72
|
+
**Started:** {timestamp}
|
|
73
|
+
**Time budget:** {minutes} minutes
|
|
74
|
+
**Task:** {verbatim task description}
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Session Log
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
If git enabled: commit with `chore: initialise brainstorming session — {session-name}`
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Phase 1: Rapid Discovery
|
|
86
|
+
|
|
87
|
+
Adapt depth to time budget. The goal is to understand enough to plan, not to achieve zero assumptions.
|
|
88
|
+
|
|
89
|
+
### Step 1: Context Scan (silent — do not output)
|
|
90
|
+
|
|
91
|
+
- Run project detection from `templates/utilities/project-detection.md` if a codebase exists
|
|
92
|
+
- Read `CLAUDE.md`, `README.md`, `tasks/todo.md` if they exist
|
|
93
|
+
- Identify tools, frameworks, and patterns already in place
|
|
94
|
+
|
|
95
|
+
### Step 2: Clarifying Questions
|
|
96
|
+
|
|
97
|
+
Use `AskUserQuestion` for each question batch. Number of questions adapts to time budget (see Phase 0 table). Focus on: scope, constraints, expected output, and success criteria.
|
|
98
|
+
|
|
99
|
+
After answers, append to scratchpad under `## Discovery`.
|
|
100
|
+
|
|
101
|
+
### Step 3: Git Checkpoint
|
|
102
|
+
|
|
103
|
+
If git enabled: commit scratchpad update with `docs: brainstorm discovery — {session-name}`
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Phase 2: Brainstorm & Approach Selection
|
|
108
|
+
|
|
109
|
+
### Step 1: Generate Approaches
|
|
110
|
+
|
|
111
|
+
Based on discovery, generate 2-4 distinct approaches (count adapts to time budget). For each approach, describe:
|
|
112
|
+
- What it involves
|
|
113
|
+
- Pros and cons
|
|
114
|
+
- Estimated effort
|
|
115
|
+
- Risk level
|
|
116
|
+
|
|
117
|
+
Append to scratchpad under `## Approaches`.
|
|
118
|
+
|
|
119
|
+
### Step 2: Select Approach
|
|
120
|
+
|
|
121
|
+
Use `AskUserQuestion`:
|
|
122
|
+
- question: "Which approach would you like to take?"
|
|
123
|
+
- header: "Approach"
|
|
124
|
+
- Present each approach as an option with a brief description
|
|
125
|
+
- Include a final option: {label: "Different approach", description: "Let me describe a different approach"}
|
|
126
|
+
|
|
127
|
+
Append selected approach to scratchpad under `## Selected Approach`.
|
|
128
|
+
|
|
129
|
+
### Step 3: Git Checkpoint
|
|
130
|
+
|
|
131
|
+
If git enabled: commit with `docs: brainstorm approach selected — {session-name}`
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## Phase 3: Plan Generation
|
|
136
|
+
|
|
137
|
+
### Step 1: Analyse Available Commands
|
|
138
|
+
|
|
139
|
+
Read all available commands from the plugin and determine which are relevant. The command inventory:
|
|
140
|
+
|
|
141
|
+
**Core Commands:**
|
|
142
|
+
- `/agentops:star` — STAR analysis and task breakdown
|
|
143
|
+
- `/agentops:interrogate` — deep requirements discovery (use if task is complex and time permits)
|
|
144
|
+
- `/agentops:plan` — generate execution plan
|
|
145
|
+
- `/agentops:workflow` — workflow mapping OR plan execution
|
|
146
|
+
- `/agentops:verify` — verification gate
|
|
147
|
+
- `/agentops:lesson` / `/agentops:lessons` — capture and review lessons learned
|
|
148
|
+
|
|
149
|
+
**Enterprise Commands:**
|
|
150
|
+
- `/agentops:scaffold` — project scaffolding (use for creating a new project)
|
|
151
|
+
- `/agentops:feature` — structured feature build (use for implementing specific features)
|
|
152
|
+
- `/agentops:review` — unified code review (use after implementation)
|
|
153
|
+
- `/agentops:test-gen` — generate tests (use after implementation)
|
|
154
|
+
- `/agentops:reason` — multi-step reasoning pipeline (use for complex decisions)
|
|
155
|
+
- `/agentops:adr` — architecture decision records (use for architecture choices)
|
|
156
|
+
- `/agentops:design` — solution design (use for design-heavy tasks)
|
|
157
|
+
- `/agentops:qa-check` — pre-deployment QA (use before marking complete)
|
|
158
|
+
- `/agentops:handover` — generate documentation (use if deliverables include docs)
|
|
159
|
+
- `/agentops:onboard` — team onboarding (use if task involves onboarding)
|
|
160
|
+
- `/agentops:knowledge` — search knowledge base (use to check for relevant patterns)
|
|
161
|
+
- `/agentops:status-report` — generate status report (use at end of session)
|
|
162
|
+
- `/agentops:code-analysis` — analyse code quality
|
|
163
|
+
- `/agentops:compliance-check` — compliance verification
|
|
164
|
+
|
|
165
|
+
**Agents (for sub-delegation):**
|
|
166
|
+
- `agents/code-critic.md` — code review with enterprise heuristics
|
|
167
|
+
- `agents/security-reviewer.md` — security review with enterprise checks
|
|
168
|
+
- `agents/interrogator.md` — requirements discovery
|
|
169
|
+
- `agents/proposer.md` — solution proposals
|
|
170
|
+
- `agents/delegation-router.md` — task delegation
|
|
171
|
+
|
|
172
|
+
### Step 2: Build Execution Plan
|
|
173
|
+
|
|
174
|
+
Based on task, time budget, and selected approach, create an ordered execution plan where each step references a specific AgentOps command or action.
|
|
175
|
+
|
|
176
|
+
**MUST include verification steps** — the plan must always include testing and review, adapted to time budget. Reserve at minimum:
|
|
177
|
+
- **10 minutes** for verification/testing (non-negotiable, even in 30-min sessions)
|
|
178
|
+
- **10 minutes** for completion report generation (for 60-min+ sessions)
|
|
179
|
+
|
|
180
|
+
Write to scratchpad under `## Execution Plan`. Also write tasks to `tasks/todo.md` in checkable format (`- [ ]`) for the workflow executor and compliance gates.
|
|
181
|
+
|
|
182
|
+
### Step 3: Present Plan
|
|
183
|
+
|
|
184
|
+
**If autonomy_level is `guided` or `supervised`:**
|
|
185
|
+
|
|
186
|
+
Use `AskUserQuestion`:
|
|
187
|
+
- question: "Here's the execution plan. Ready to proceed?"
|
|
188
|
+
- header: "Plan"
|
|
189
|
+
- options: [{label: "Execute the plan (Recommended)", description: "Proceed with guided execution"}, {label: "Adjust the plan", description: "I want to change something before we start"}, {label: "Let me review first", description: "Give me a moment to read through it"}]
|
|
190
|
+
|
|
191
|
+
If "Adjust": ask what to change via `AskUserQuestion`, update plan, re-present.
|
|
192
|
+
|
|
193
|
+
**If autonomy_level is `autonomous`:**
|
|
194
|
+
State: "Plan generated. Proceeding with execution (autonomous mode)." and continue.
|
|
195
|
+
|
|
196
|
+
### Step 4: Git Checkpoint
|
|
197
|
+
|
|
198
|
+
If git enabled: commit with `docs: brainstorm execution plan — {session-name}`
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## Phase 4: Guided Execution
|
|
203
|
+
|
|
204
|
+
This is where the brainstorm transitions into doing. Execute the plan step by step using the relevant AgentOps commands.
|
|
205
|
+
|
|
206
|
+
### For each step in the execution plan:
|
|
207
|
+
|
|
208
|
+
1. **Announce:** "Step {n}/{total}: {description}"
|
|
209
|
+
2. **Execute** the relevant command/action
|
|
210
|
+
3. **Log:** After completion, update scratchpad under `## Execution Log` with:
|
|
211
|
+
- What was done
|
|
212
|
+
- What was produced
|
|
213
|
+
- Any issues encountered
|
|
214
|
+
- Time taken
|
|
215
|
+
4. **Track:** Mark the task complete in `tasks/todo.md`
|
|
216
|
+
5. **If autonomy_level is `supervised`:** After each step, use `AskUserQuestion`:
|
|
217
|
+
- question: "Step {n} complete. What next?"
|
|
218
|
+
- header: "Step"
|
|
219
|
+
- options: [{label: "Continue (Recommended)", description: "Proceed to next step"}, {label: "Review changes", description: "Show me what was changed before continuing"}, {label: "Modify plan", description: "Adjust remaining steps"}]
|
|
220
|
+
6. **Git checkpoint:** If git enabled, commit all changes with a conventional commit message (e.g., `feat: implement supplier directory API endpoint`, `test: add integration tests for supplier service`, `docs: generate architecture decision record`)
|
|
221
|
+
|
|
222
|
+
### Time Management
|
|
223
|
+
|
|
224
|
+
Track elapsed time against budget. If approaching budget with steps remaining, use `AskUserQuestion`:
|
|
225
|
+
- question: "We're running low on time ({minutes} remaining, {steps} steps left). How should we proceed?"
|
|
226
|
+
- header: "Time"
|
|
227
|
+
- options: [{label: "Rush through remaining steps", description: "Complete remaining work quickly with less polish"}, {label: "Skip to verification", description: "Jump to testing and review now"}, {label: "Extend the session", description: "Remove the time constraint"}, {label: "Stop here", description: "Wrap up with what we have"}]
|
|
228
|
+
|
|
229
|
+
**NEVER skip Phase 5 (Verification) due to time pressure** — verification is non-negotiable. If time is tight, reduce verification scope but always run it.
|
|
230
|
+
|
|
231
|
+
### Adaptive Command Selection
|
|
232
|
+
|
|
233
|
+
- If implementation is code: use `/agentops:feature` for the build, then `/agentops:review` and `/agentops:test-gen`
|
|
234
|
+
- If task is research/analysis: use `/agentops:reason` for structured analysis
|
|
235
|
+
- If task is design: use `/agentops:design` for solution design
|
|
236
|
+
- If task produces a new project: use `/agentops:scaffold` first
|
|
237
|
+
- Always finish with `/agentops:review` if code was written
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
## Phase 5: Verification & Testing
|
|
242
|
+
|
|
243
|
+
**This phase is NON-NEGOTIABLE.** Every session must verify its own work before completion. Adapt scope to time budget but never skip entirely.
|
|
244
|
+
|
|
245
|
+
### Step 1: Automated Testing
|
|
246
|
+
|
|
247
|
+
If code was written during execution:
|
|
248
|
+
- Run `/agentops:test-gen` if tests don't already exist
|
|
249
|
+
- Execute the test suite: detect the test runner from project config (`npm test`, `pytest`, `go test`, `cargo test`, etc.)
|
|
250
|
+
- Capture test results (pass/fail counts, coverage if available)
|
|
251
|
+
- If tests fail: fix the failures before proceeding. This is not optional.
|
|
252
|
+
- Append results to scratchpad under `## Verification — Automated Tests`
|
|
253
|
+
- If git enabled: commit with `test: run verification suite — all passing`
|
|
254
|
+
|
|
255
|
+
### Step 2: Linting & Static Analysis
|
|
256
|
+
|
|
257
|
+
If the project has a linter configured:
|
|
258
|
+
- Run it (`npm run lint`, `eslint .`, etc.)
|
|
259
|
+
- Fix any linting errors (warnings can be noted but don't block)
|
|
260
|
+
- Run `/agentops:code-analysis` if time permits
|
|
261
|
+
- Append results to scratchpad under `## Verification — Static Analysis`
|
|
262
|
+
- If git enabled: commit fixes with `fix: resolve linting errors`
|
|
263
|
+
|
|
264
|
+
### Step 3: Browser Testing (if applicable)
|
|
265
|
+
|
|
266
|
+
Determine if browser testing is needed: does the task involve a web UI, frontend component, API with a browser-accessible interface, or anything that renders in a browser?
|
|
267
|
+
|
|
268
|
+
If yes:
|
|
269
|
+
- Start the development server (`npm run dev`, `npm start`, or equivalent)
|
|
270
|
+
- Open the application in a browser
|
|
271
|
+
- Verify: pages load without errors, key user flows function, no console errors, responsive layout correct
|
|
272
|
+
- Take screenshots of key states as evidence
|
|
273
|
+
- Save screenshots to `./docs/brainstorming/{session-name}/screenshots/`
|
|
274
|
+
- Append results to scratchpad under `## Verification — Browser Testing`
|
|
275
|
+
- If git enabled: commit with `test: browser verification — all key flows working`
|
|
276
|
+
|
|
277
|
+
### Step 4: Code Review
|
|
278
|
+
|
|
279
|
+
- Run `/agentops:review` on all code written during the session
|
|
280
|
+
- Address any Critical or High severity findings
|
|
281
|
+
- Note Medium/Low findings in the scratchpad but don't block on them
|
|
282
|
+
- Append review summary to scratchpad under `## Verification — Code Review`
|
|
283
|
+
- If git enabled: commit any fixes with `fix: address code review findings`
|
|
284
|
+
|
|
285
|
+
### Step 5: Verification Summary
|
|
286
|
+
|
|
287
|
+
Append to scratchpad under `## Verification Summary`:
|
|
288
|
+
|
|
289
|
+
```markdown
|
|
290
|
+
### Verification Results
|
|
291
|
+
- **Automated Tests:** {PASS/FAIL} — {X} passing, {Y} failing, {Z}% coverage
|
|
292
|
+
- **Linting:** {PASS/FAIL} — {X} errors, {Y} warnings
|
|
293
|
+
- **Browser Testing:** {PASS/FAIL/N/A} — {summary}
|
|
294
|
+
- **Code Review:** {PASS/NEEDS ATTENTION} — {X} critical, {Y} high, {Z} medium findings
|
|
295
|
+
- **Overall:** {READY FOR DELIVERY / NEEDS FIXES}
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
If any critical issues remain, use `AskUserQuestion`:
|
|
299
|
+
- question: "Verification found issues. How should we proceed?"
|
|
300
|
+
- header: "Issues"
|
|
301
|
+
- options: [{label: "Fix the issues now (Recommended)", description: "Address critical issues before completing"}, {label: "Note them and proceed", description: "Document the issues but generate the completion report anyway"}, {label: "Extend session to fix", description: "Remove time constraint and fix everything"}]
|
|
302
|
+
|
|
303
|
+
---
|
|
304
|
+
|
|
305
|
+
## Phase 6: Completion Report Generation
|
|
306
|
+
|
|
307
|
+
**Generate a professional, self-contained completion report** that can be sent directly as a deliverable. Skip this phase only for 30-minute sessions.
|
|
308
|
+
|
|
309
|
+
### Step 1: Generate Report
|
|
310
|
+
|
|
311
|
+
Create `./docs/brainstorming/{session-name}/completion-report.md`:
|
|
312
|
+
|
|
313
|
+
```markdown
|
|
314
|
+
# Session Completion Report
|
|
315
|
+
|
|
316
|
+
**Date:** {date}
|
|
317
|
+
**Duration:** {actual time spent}
|
|
318
|
+
**Task:** {task description}
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
## Executive Summary
|
|
323
|
+
|
|
324
|
+
2-3 sentences summarising what was accomplished, the approach taken, and the outcome.
|
|
325
|
+
|
|
326
|
+
## Task Analysis
|
|
327
|
+
|
|
328
|
+
### Understanding
|
|
329
|
+
What the task required — restated in the engineer's own words to demonstrate comprehension.
|
|
330
|
+
|
|
331
|
+
### Approach
|
|
332
|
+
Why this approach was chosen over alternatives. Include:
|
|
333
|
+
- Alternatives considered (brief)
|
|
334
|
+
- Why the selected approach was best (rationale)
|
|
335
|
+
- Key trade-offs accepted
|
|
336
|
+
|
|
337
|
+
## Implementation
|
|
338
|
+
|
|
339
|
+
### Architecture & Design Decisions
|
|
340
|
+
For each significant decision made during the session:
|
|
341
|
+
- **Decision:** What was decided
|
|
342
|
+
- **Context:** Why this decision was needed
|
|
343
|
+
- **Rationale:** Why this option was chosen
|
|
344
|
+
- **Alternatives rejected:** What else was considered and why it was dismissed
|
|
345
|
+
- **Implications:** What this means for future work
|
|
346
|
+
|
|
347
|
+
### Steps Completed
|
|
348
|
+
Ordered list of what was done, with brief descriptions:
|
|
349
|
+
1. {Step} — {what was done and what it produced}
|
|
350
|
+
2. {Step} — {what was done and what it produced}
|
|
351
|
+
|
|
352
|
+
### Files Created / Modified
|
|
353
|
+
Complete list of all files produced or changed, with brief descriptions of each.
|
|
354
|
+
|
|
355
|
+
## Verification & Quality
|
|
356
|
+
|
|
357
|
+
### Testing Results
|
|
358
|
+
- Automated tests: {results}
|
|
359
|
+
- Linting/static analysis: {results}
|
|
360
|
+
- Browser testing: {results, if applicable}
|
|
361
|
+
- Code review: {summary of findings and resolutions}
|
|
362
|
+
|
|
363
|
+
### Quality Assessment
|
|
364
|
+
Honest self-assessment of the work quality. What's production-ready, what would benefit from further iteration, and what the next steps would be.
|
|
365
|
+
|
|
366
|
+
## Technical Notes
|
|
367
|
+
|
|
368
|
+
### Technology Choices
|
|
369
|
+
What technologies/tools were used and why.
|
|
370
|
+
|
|
371
|
+
### Patterns Applied
|
|
372
|
+
What architectural or design patterns were applied and why they're appropriate for this context.
|
|
373
|
+
|
|
374
|
+
### Known Limitations
|
|
375
|
+
Anything that's intentionally simplified, mocked, or deferred — and why.
|
|
376
|
+
|
|
377
|
+
## What I Would Do Next
|
|
378
|
+
|
|
379
|
+
If this work were to continue, what would the immediate next steps be? Prioritised list of improvements, features, or refinements.
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
**If git was enabled**, append a `## Repository` section:
|
|
383
|
+
|
|
384
|
+
```markdown
|
|
385
|
+
## Repository
|
|
386
|
+
|
|
387
|
+
All work is tracked in a git repository with conventional commit messages. To review the full history of decisions and changes:
|
|
388
|
+
|
|
389
|
+
```
|
|
390
|
+
git log --oneline
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
Each commit represents a discrete step in the process, from initial setup through implementation, testing, and verification. The commit history provides a complete audit trail of how the solution was developed.
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
If git was NOT enabled, omit the Repository section entirely.
|
|
397
|
+
|
|
398
|
+
### Step 2: Report Quality Standards
|
|
399
|
+
|
|
400
|
+
The report must be:
|
|
401
|
+
- **Professional and enterprise-appropriate** — suitable for sending to a senior stakeholder
|
|
402
|
+
- **Clear and concise** — no filler, no unnecessary preamble
|
|
403
|
+
- **Evidence-backed** — every claim references specific files, test results, or decisions
|
|
404
|
+
- **Honest about limitations** — acknowledging what's incomplete shows maturity
|
|
405
|
+
- **Standalone** — the recipient must understand everything without additional context
|
|
406
|
+
- Must NOT mention any specific person, company, or interview context
|
|
407
|
+
|
|
408
|
+
### Step 3: Git Checkpoint
|
|
409
|
+
|
|
410
|
+
If git enabled: commit with `docs: generate session completion report`
|
|
411
|
+
|
|
412
|
+
---
|
|
413
|
+
|
|
414
|
+
## Phase 7: Session Wrap-Up
|
|
415
|
+
|
|
416
|
+
### Step 1: Lessons Learned
|
|
417
|
+
|
|
418
|
+
If anything noteworthy happened during the session, capture via `/agentops:lesson`.
|
|
419
|
+
|
|
420
|
+
### Step 2: Final Commit
|
|
421
|
+
|
|
422
|
+
If git enabled:
|
|
423
|
+
- Ensure ALL work is committed (no uncommitted changes)
|
|
424
|
+
- Final commit: `docs: complete brainstorming session — {session-name}`
|
|
425
|
+
- Run and display `git log --oneline` showing the full session history
|
|
426
|
+
|
|
427
|
+
### Step 3: Present Results
|
|
428
|
+
|
|
429
|
+
Show the user what was produced:
|
|
430
|
+
- Link to the completion report: `./docs/brainstorming/{session-name}/completion-report.md`
|
|
431
|
+
- Link to the scratchpad: `./docs/brainstorming/{session-name}/scratchpad.md`
|
|
432
|
+
- If code was built: show the project structure
|
|
433
|
+
- If screenshots were taken: list them
|
|
434
|
+
|
|
435
|
+
Inform the user: "The completion report at `completion-report.md` is ready to send as a standalone deliverable."
|
|
436
|
+
|
|
437
|
+
If git was enabled: display the `git log --oneline` output and note that this provides a full audit trail of how the solution was developed.
|
|
438
|
+
|
|
439
|
+
---
|
|
440
|
+
|
|
441
|
+
## Git Auto-Commit Behaviour
|
|
442
|
+
|
|
443
|
+
When git is enabled, commit automatically at natural breakpoints using conventional commits:
|
|
444
|
+
- `chore:` — session setup, config changes
|
|
445
|
+
- `docs:` — brainstorming artifacts, scratchpad updates, documentation, completion report
|
|
446
|
+
- `feat:` — new features implemented during execution
|
|
447
|
+
- `fix:` — bug fixes during execution, lint fixes, review fixes
|
|
448
|
+
- `test:` — test generation, test execution, browser verification
|
|
449
|
+
- `refactor:` — code improvements during review
|
|
450
|
+
|
|
451
|
+
---
|
|
452
|
+
|
|
453
|
+
## Error Handling
|
|
454
|
+
|
|
455
|
+
- If project detection fails, ask the user to describe the tech stack manually via `AskUserQuestion`
|
|
456
|
+
- If a task fails during execution, offer alternatives rather than stopping — use `AskUserQuestion` to present recovery options
|
|
457
|
+
- If the user wants to abort at any phase, clean up gracefully and summarise what was completed
|
|
458
|
+
- Never leave the codebase in a broken state — if aborting mid-implementation, ensure all written files are syntactically valid
|
|
459
|
+
- If an AgentOps command referenced in the plan is unavailable, fall back to manual execution of the equivalent steps
|
|
460
|
+
|
|
461
|
+
Arguments: $ARGUMENTS
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: design
|
|
3
|
+
description: Solution design phase — architecture proposals, integration mapping, risk assessment
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are a solution design assistant for enterprise delivery engagements. You guide engineers through creating structured, client-presentation-quality solution design documents.
|
|
7
|
+
|
|
8
|
+
**Before starting, check the feature flag:**
|
|
9
|
+
Run: `source hooks/feature-flags.sh && agentops_enterprise_enabled "delivery_lifecycle"` — if disabled, inform the user and stop.
|
|
10
|
+
|
|
11
|
+
## CRITICAL RULE: Use AskUserQuestion Tool
|
|
12
|
+
|
|
13
|
+
You MUST use the `AskUserQuestion` tool for EVERY question in this command. DO NOT print questions as plain text or numbered option lists. Call the AskUserQuestion tool which renders a proper selection UI. This is a BLOCKING REQUIREMENT.
|
|
14
|
+
|
|
15
|
+
The design context: $ARGUMENTS
|
|
16
|
+
|
|
17
|
+
If no arguments provided, use AskUserQuestion to ask what solution is being designed.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Phase 1: Context Gathering
|
|
22
|
+
|
|
23
|
+
### 1.1 Codebase Analysis
|
|
24
|
+
- Run project detection from `templates/utilities/project-detection.md`
|
|
25
|
+
- Read project structure and identify existing patterns
|
|
26
|
+
- Map current dependencies and frameworks
|
|
27
|
+
- Identify existing integration points
|
|
28
|
+
|
|
29
|
+
### 1.2 Requirements Review
|
|
30
|
+
- Read any existing discovery/requirements documents (check `docs/interrogation/`)
|
|
31
|
+
- Identify functional requirements (what it must do)
|
|
32
|
+
- Identify non-functional requirements (performance, security, scalability)
|
|
33
|
+
- List constraints (timeline, budget, team skills, compliance)
|
|
34
|
+
|
|
35
|
+
### 1.3 Stakeholder Context
|
|
36
|
+
- Who is the end user?
|
|
37
|
+
- Who approves this design?
|
|
38
|
+
- What are the success criteria?
|
|
39
|
+
- What is the timeline?
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Phase 2: Architecture Proposal
|
|
44
|
+
|
|
45
|
+
### 2.1 High-Level Architecture
|
|
46
|
+
|
|
47
|
+
Present the architecture using a text diagram or Mermaid:
|
|
48
|
+
|
|
49
|
+
```markdown
|
|
50
|
+
## Architecture Overview
|
|
51
|
+
|
|
52
|
+
### Component Diagram
|
|
53
|
+
[Describe each component, its responsibility, and how they connect]
|
|
54
|
+
|
|
55
|
+
### Technology Choices
|
|
56
|
+
| Component | Technology | Rationale |
|
|
57
|
+
|-----------|-----------|-----------|
|
|
58
|
+
| Frontend | [choice] | [why this over alternatives] |
|
|
59
|
+
| API | [choice] | [why] |
|
|
60
|
+
| Database | [choice] | [why] |
|
|
61
|
+
| Cache | [choice] | [why] |
|
|
62
|
+
| Queue | [choice] | [why — if applicable] |
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### 2.2 Component Breakdown
|
|
66
|
+
|
|
67
|
+
For each component in the architecture:
|
|
68
|
+
|
|
69
|
+
```markdown
|
|
70
|
+
### [Component Name]
|
|
71
|
+
**Purpose:** [single sentence]
|
|
72
|
+
**Responsibility:** [what it does and doesn't do]
|
|
73
|
+
**Technology:** [framework/library]
|
|
74
|
+
**Interfaces:**
|
|
75
|
+
- Exposes: [APIs, events, or exports]
|
|
76
|
+
- Consumes: [APIs, events, or imports]
|
|
77
|
+
**Data:** [what data it owns/manages]
|
|
78
|
+
**Complexity:** S / M / L
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 2.3 Data Model
|
|
82
|
+
|
|
83
|
+
Define the key entities and their relationships:
|
|
84
|
+
|
|
85
|
+
```markdown
|
|
86
|
+
### Data Model
|
|
87
|
+
| Entity | Key Fields | Relationships | Multi-tenant |
|
|
88
|
+
|--------|-----------|---------------|-------------|
|
|
89
|
+
| [entity] | [fields] | [belongs to / has many] | Yes/No |
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Phase 3: Integration Mapping
|
|
95
|
+
|
|
96
|
+
For each external system integration:
|
|
97
|
+
|
|
98
|
+
```markdown
|
|
99
|
+
### Integration Map
|
|
100
|
+
|
|
101
|
+
| # | Source | Target | Protocol | Auth | Data Flow | Frequency |
|
|
102
|
+
|---|--------|--------|----------|------|-----------|-----------|
|
|
103
|
+
| 1 | Our API | [system] | REST/gRPC | OAuth2/API Key | Request/Response | On-demand |
|
|
104
|
+
| 2 | [system] | Our API | Webhook | HMAC signature | Push | Event-driven |
|
|
105
|
+
|
|
106
|
+
### Integration Details
|
|
107
|
+
|
|
108
|
+
#### Integration 1: [Name]
|
|
109
|
+
- **Purpose:** [why we integrate]
|
|
110
|
+
- **Data exchanged:** [what flows between systems]
|
|
111
|
+
- **Error handling:** [what happens when the external system is down]
|
|
112
|
+
- **Adapter pattern:** Use the adapter template from `templates/integration/adapter-pattern.md`
|
|
113
|
+
- **Contract testing:** [how we verify the integration contract]
|
|
114
|
+
- **SLA dependency:** [uptime/latency requirements from external system]
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Phase 4: Risk Assessment
|
|
120
|
+
|
|
121
|
+
Use a structured likelihood x impact matrix:
|
|
122
|
+
|
|
123
|
+
```markdown
|
|
124
|
+
### Risk Assessment
|
|
125
|
+
|
|
126
|
+
| ID | Risk | Category | Likelihood | Impact | Score | Mitigation | Owner |
|
|
127
|
+
|----|------|----------|-----------|--------|-------|------------|-------|
|
|
128
|
+
| R1 | [risk description] | Technical | H/M/L (3/2/1) | H/M/L (3/2/1) | [L*I] | [mitigation plan] | [name] |
|
|
129
|
+
|
|
130
|
+
**Risk scoring:** Score = Likelihood x Impact (1-9)
|
|
131
|
+
- **6-9 (Critical):** Requires active mitigation and stakeholder visibility
|
|
132
|
+
- **3-5 (Significant):** Monitor and prepare contingency
|
|
133
|
+
- **1-2 (Manageable):** Accept and monitor
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Categories to cover:
|
|
137
|
+
- **Technical:** Architecture complexity, unfamiliar technology, performance unknowns
|
|
138
|
+
- **Integration:** External system reliability, API changes, contract drift
|
|
139
|
+
- **Security:** Data protection, auth complexity, compliance requirements
|
|
140
|
+
- **Resource:** Team skill gaps, availability, key person dependencies
|
|
141
|
+
- **Timeline:** Scope creep, dependency delays, environment provisioning
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## Phase 5: Spike Management
|
|
146
|
+
|
|
147
|
+
If the design includes unknowns that need exploration:
|
|
148
|
+
|
|
149
|
+
```markdown
|
|
150
|
+
### Technical Spikes Required
|
|
151
|
+
|
|
152
|
+
| # | Hypothesis | Time Box | Deliverable | Priority |
|
|
153
|
+
|---|-----------|----------|-------------|----------|
|
|
154
|
+
| 1 | "[Technology X] can handle [requirement Y]" | 2 days | Proof of concept + findings doc | Must do before Phase 2 |
|
|
155
|
+
| 2 | "[Integration Z] supports [data format W]" | 1 day | API response samples + contract test | Can parallel |
|
|
156
|
+
|
|
157
|
+
**Spike protocol:** Use the spike template from `templates/workflows/spike-exploration.md`
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## Phase 6: Effort Estimate
|
|
163
|
+
|
|
164
|
+
```markdown
|
|
165
|
+
### Effort Estimate
|
|
166
|
+
|
|
167
|
+
| Phase | Activities | Effort (days) | Dependencies | Risk Buffer |
|
|
168
|
+
|-------|-----------|--------------|-------------|-------------|
|
|
169
|
+
| Data model + migrations | Schema design, Prisma setup, seed data | [N] | — | +20% |
|
|
170
|
+
| Backend services | Business logic, adapters, tests | [N] | Data model | +20% |
|
|
171
|
+
| API layer | Routes, middleware, validation, docs | [N] | Services | +10% |
|
|
172
|
+
| Frontend | Components, pages, state, tests | [N] | API | +20% |
|
|
173
|
+
| Integration | External adapters, contract tests | [N] | API | +30% |
|
|
174
|
+
| QA | Test plan, execution, fixes | [N] | All above | +10% |
|
|
175
|
+
| **Total** | | **[N] days** | | |
|
|
176
|
+
|
|
177
|
+
**Range estimate:**
|
|
178
|
+
- Best case: [N] days (all assumptions hold, no surprises)
|
|
179
|
+
- Expected: [N] days (moderate unknowns)
|
|
180
|
+
- Worst case: [N] days (significant unknowns materialise)
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Phase 7: Design Review Gate
|
|
186
|
+
|
|
187
|
+
Present the complete design document, then call `AskUserQuestion`:
|
|
188
|
+
- question: "Design review — how would you like to proceed?"
|
|
189
|
+
- header: "Review"
|
|
190
|
+
- options: [{label: "Approve (Recommended)", description: "Proceed to implementation planning"}, {label: "Modify", description: "Request changes to specific sections"}, {label: "Spike first", description: "Run technical spikes before approving"}, {label: "Reject", description: "Fundamental concerns — redesign needed"}]
|
|
191
|
+
|
|
192
|
+
If approved, suggest next steps:
|
|
193
|
+
- Create ADR for key decisions: `/agentops:adr`
|
|
194
|
+
- Plan implementation: `/agentops:feature` or `/agentops:plan`
|
|
195
|
+
- Set up project structure: `/agentops:scaffold`
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## Error Handling
|
|
200
|
+
|
|
201
|
+
- If project detection finds nothing, ask the user to describe the target architecture
|
|
202
|
+
- If requirements are ambiguous, suggest running `/agentops:interrogate` first
|
|
203
|
+
- If the user doesn't have answers to stakeholder questions, document as assumptions and flag for follow-up
|