superkit-mcp-server 1.2.4 → 1.2.6
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/ARCHITECTURE.md +102 -102
- package/README.md +71 -71
- package/SUPERKIT.md +168 -168
- package/agents/code-archaeologist.md +106 -106
- package/agents/coder.md +90 -90
- package/agents/data-engineer.md +28 -28
- package/agents/devops-engineer.md +242 -242
- package/agents/git-manager.md +203 -203
- package/agents/orchestrator.md +420 -420
- package/agents/penetration-tester.md +188 -188
- package/agents/performance-optimizer.md +187 -187
- package/agents/planner.md +270 -270
- package/agents/qa-automation-engineer.md +103 -103
- package/agents/quant-developer.md +32 -32
- package/agents/reviewer.md +100 -100
- package/agents/scout.md +222 -222
- package/agents/tester.md +274 -274
- package/agents/ui-designer.md +208 -208
- package/build/__tests__/test_apply_prompt_args.js +104 -0
- package/build/index.js +106 -45
- package/build/tools/todoTools.js +39 -39
- package/build/tools/validators/__tests__/apiSchema.test.js +23 -23
- package/build/tools/validators/__tests__/convertRules.test.js +5 -5
- package/build/tools/validators/__tests__/frontendDesign.test.js +12 -12
- package/build/tools/validators/__tests__/geoChecker.test.js +19 -19
- package/build/tools/validators/__tests__/mobileAudit.test.js +12 -12
- package/build/tools/validators/__tests__/reactPerformanceChecker.test.js +17 -17
- package/build/tools/validators/__tests__/securityScan.test.js +6 -6
- package/build/tools/validators/__tests__/seoChecker.test.js +16 -16
- package/build/tools/validators/__tests__/typeCoverage.test.js +14 -14
- package/commands/README.md +122 -122
- package/commands/ask.toml +72 -72
- package/commands/brainstorm.toml +119 -119
- package/commands/chat.toml +77 -77
- package/commands/code-preview.toml +37 -37
- package/commands/code.toml +28 -28
- package/commands/content.toml +200 -200
- package/commands/cook.toml +77 -77
- package/commands/copywrite.toml +131 -131
- package/commands/db.toml +192 -192
- package/commands/debug.toml +166 -166
- package/commands/design.toml +158 -158
- package/commands/dev-rules.toml +14 -14
- package/commands/do.toml +117 -117
- package/commands/doc-rules.toml +14 -14
- package/commands/docs.toml +148 -148
- package/commands/fix.toml +440 -440
- package/commands/fullstack.toml +175 -175
- package/commands/git.toml +235 -235
- package/commands/help.toml +84 -84
- package/commands/integrate.toml +127 -127
- package/commands/journal.toml +136 -136
- package/commands/kit-setup.toml +40 -40
- package/commands/mcp.toml +183 -183
- package/commands/orchestration.toml +15 -15
- package/commands/plan.toml +206 -172
- package/commands/pm.toml +148 -148
- package/commands/pr.toml +50 -50
- package/commands/project.toml +32 -32
- package/commands/research.toml +117 -117
- package/commands/review-pr.toml +63 -63
- package/commands/review.toml +190 -190
- package/commands/scout-ext.toml +97 -97
- package/commands/scout.toml +79 -79
- package/commands/screenshot.toml +65 -65
- package/commands/session.toml +102 -102
- package/commands/skill.toml +384 -384
- package/commands/status.toml +22 -22
- package/commands/team.toml +56 -56
- package/commands/test.toml +164 -164
- package/commands/ticket.toml +70 -70
- package/commands/use.toml +106 -106
- package/commands/video.toml +83 -83
- package/commands/watzup.toml +71 -71
- package/commands/workflow.toml +14 -14
- package/package.json +35 -35
- package/skills/meta/README.md +30 -30
- package/skills/meta/api-design/SKILL.md +134 -134
- package/skills/meta/code-review/SKILL.md +44 -44
- package/skills/meta/code-review/checklists/pre-merge.md +25 -25
- package/skills/meta/code-review/workflows/architecture-pass.md +26 -26
- package/skills/meta/code-review/workflows/performance-pass.md +27 -27
- package/skills/meta/code-review/workflows/security-pass.md +29 -29
- package/skills/meta/compound-docs/SKILL.md +133 -133
- package/skills/meta/debug/SKILL.md +40 -40
- package/skills/meta/debug/templates/bug-report.template.md +31 -31
- package/skills/meta/debug/workflows/reproduce-issue.md +20 -20
- package/skills/meta/docker/SKILL.md +126 -126
- package/skills/meta/examples/supabase/SKILL.md +46 -46
- package/skills/meta/examples/supabase/references/best-practices.md +319 -319
- package/skills/meta/examples/supabase/references/common-patterns.md +373 -373
- package/skills/meta/examples/supabase/templates/migration-template.sql +49 -49
- package/skills/meta/examples/supabase/templates/rls-policy-template.sql +77 -77
- package/skills/meta/examples/supabase/workflows/debugging.md +260 -260
- package/skills/meta/examples/supabase/workflows/migration-workflow.md +211 -211
- package/skills/meta/examples/supabase/workflows/rls-policies.md +244 -244
- package/skills/meta/examples/supabase/workflows/schema-design.md +321 -321
- package/skills/meta/file-todos/SKILL.md +88 -88
- package/skills/meta/mobile/SKILL.md +140 -140
- package/skills/meta/nextjs/SKILL.md +101 -101
- package/skills/meta/performance/SKILL.md +130 -130
- package/skills/meta/react-patterns/SKILL.md +83 -83
- package/skills/meta/security/SKILL.md +114 -114
- package/skills/meta/session-resume/SKILL.md +96 -96
- package/skills/meta/tailwind/SKILL.md +139 -139
- package/skills/meta/testing/SKILL.md +43 -43
- package/skills/meta/testing/references/vitest-patterns.md +45 -45
- package/skills/meta/testing/templates/component-test.template.tsx +37 -37
- package/skills/tech/alpha-vantage/SKILL.md +142 -142
- package/skills/tech/alpha-vantage/references/commodities.md +153 -153
- package/skills/tech/alpha-vantage/references/economic-indicators.md +158 -158
- package/skills/tech/alpha-vantage/references/forex-crypto.md +154 -154
- package/skills/tech/alpha-vantage/references/fundamentals.md +223 -223
- package/skills/tech/alpha-vantage/references/intelligence.md +138 -138
- package/skills/tech/alpha-vantage/references/options.md +93 -93
- package/skills/tech/alpha-vantage/references/technical-indicators.md +374 -374
- package/skills/tech/alpha-vantage/references/time-series.md +157 -157
- package/skills/tech/financial-modeling/SKILL.md +18 -18
- package/skills/tech/financial-modeling/skills/3-statements/SKILL.md +368 -368
- package/skills/tech/financial-modeling/skills/3-statements/references/formatting.md +118 -118
- package/skills/tech/financial-modeling/skills/3-statements/references/formulas.md +292 -292
- package/skills/tech/financial-modeling/skills/3-statements/references/sec-filings.md +125 -125
- package/skills/tech/financial-modeling/skills/dcf-model/SKILL.md +1210 -1210
- package/skills/tech/financial-modeling/skills/dcf-model/TROUBLESHOOTING.md +40 -40
- package/skills/tech/financial-modeling/skills/dcf-model/requirements.txt +8 -8
- package/skills/tech/financial-modeling/skills/dcf-model/scripts/validate_dcf.py +292 -292
- package/skills/tech/financial-modeling/skills/lbo-model/SKILL.md +236 -236
- package/skills/tech/financial-modeling/skills/merger-model/SKILL.md +108 -108
- package/skills/workflows/README.md +203 -203
- package/skills/workflows/adr.md +174 -174
- package/skills/workflows/changelog.md +74 -74
- package/skills/workflows/compound.md +323 -323
- package/skills/workflows/compound_health.md +74 -74
- package/skills/workflows/create-agent-skill.md +138 -138
- package/skills/workflows/cycle.md +144 -144
- package/skills/workflows/deploy-docs.md +84 -84
- package/skills/workflows/development-rules.md +42 -42
- package/skills/workflows/doc.md +95 -95
- package/skills/workflows/documentation-management.md +34 -34
- package/skills/workflows/explore.md +146 -146
- package/skills/workflows/generate_command.md +106 -106
- package/skills/workflows/heal-skill.md +97 -97
- package/skills/workflows/housekeeping.md +229 -229
- package/skills/workflows/kit-setup.md +102 -102
- package/skills/workflows/map-codebase.md +78 -78
- package/skills/workflows/orchestration-protocol.md +43 -43
- package/skills/workflows/plan-compound.md +439 -439
- package/skills/workflows/plan_review.md +269 -269
- package/skills/workflows/primary-workflow.md +37 -37
- package/skills/workflows/promote_pattern.md +86 -86
- package/skills/workflows/release-docs.md +82 -82
- package/skills/workflows/report-bug.md +135 -135
- package/skills/workflows/reproduce-bug.md +118 -118
- package/skills/workflows/resolve_pr.md +133 -133
- package/skills/workflows/resolve_todo.md +128 -128
- package/skills/workflows/review-compound.md +376 -376
- package/skills/workflows/skill-review.md +127 -127
- package/skills/workflows/specs.md +257 -257
- package/skills/workflows/triage-sprint.md +102 -102
- package/skills/workflows/triage.md +152 -152
- package/skills/workflows/work.md +399 -399
- package/skills/workflows/xcode-test.md +93 -93
package/skills/workflows/doc.md
CHANGED
|
@@ -1,95 +1,95 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Update folder-level documentation and component changelogs. Use after modifying components or adding new ones.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# /doc - Update Folder Documentation
|
|
6
|
-
|
|
7
|
-
Maintain living, component-level documentation in folder README files.
|
|
8
|
-
|
|
9
|
-
> **Why /doc?** Component-level context evaporates quickly. Documenting the "why" and "when" of changes ensures the codebase remains understandable as it grows.
|
|
10
|
-
|
|
11
|
-
## When To Use
|
|
12
|
-
|
|
13
|
-
- After modifying a component's core logic
|
|
14
|
-
- When adding a new file to a directory
|
|
15
|
-
- As a handoff step in the `/review` workflow
|
|
16
|
-
- When referencing a new ADR in a component
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Workflow
|
|
21
|
-
|
|
22
|
-
### Step 1: Identify Target Folder
|
|
23
|
-
|
|
24
|
-
Identify which folder's `README.md` needs updating.
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
# If not provided, list modified folders
|
|
28
|
-
git diff main --name-only | xargs -n1 dirname | sort -u
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### Step 2: Read Existing README
|
|
32
|
-
|
|
33
|
-
Check if a `README.md` exists. If not, bootstrap it using the template.
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
# Check for README
|
|
37
|
-
ls {folder_path}/README.md
|
|
38
|
-
|
|
39
|
-
# If missing, use bootstrap script
|
|
40
|
-
Call MCP `call_tool_docs_manager` { action: "bootstrap", folder: "{folder_path}" }
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Step 3: Update Components Table
|
|
44
|
-
|
|
45
|
-
If a new component was added, ensure it's in the table.
|
|
46
|
-
|
|
47
|
-
| Component | Purpose | Status |
|
|
48
|
-
|-----------|---------|--------|
|
|
49
|
-
| `NewComponent.tsx` | {Purpose} | `🏗️ Building` |
|
|
50
|
-
|
|
51
|
-
### Step 4: Add Tiered Component Details
|
|
52
|
-
|
|
53
|
-
Update the `## Component Details` section with depth based on the component's [Tier](../../docs/templates/component-tier-guide.md).
|
|
54
|
-
|
|
55
|
-
- **🔴 Critical**: Full detail (Purpose, Functionality, Tech, Error Handling, Usage).
|
|
56
|
-
- **🟡 Supporting**: Brief purpose and key exports.
|
|
57
|
-
- **🟢 Generated**: One-line description.
|
|
58
|
-
|
|
59
|
-
### Step 5: Add Changelog Entry
|
|
60
|
-
|
|
61
|
-
Document the change, including the "why" and relevant references.
|
|
62
|
-
|
|
63
|
-
```markdown
|
|
64
|
-
### {YYYY-MM-DD}
|
|
65
|
-
- {Change description} (Response to: {Link to TODO/Spec/ADR})
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
### Step 6: Verify Links
|
|
69
|
-
|
|
70
|
-
Ensure any newly added links to ADRs or other documentation are valid.
|
|
71
|
-
|
|
72
|
-
### Step 7: Integration Audit (Sibling Parity)
|
|
73
|
-
|
|
74
|
-
If you created a NEW folder, ensure it is covered by the validation system:
|
|
75
|
-
1. Run `Call MCP `call_tool_docs_manager` { action: "discover" }` to verify discovery.
|
|
76
|
-
2. Run `Call MCP `call_tool_docs_manager` { action: "validate", strict: false }` to verify structure.
|
|
77
|
-
3. If new patterns were established, update `docs/solutions/patterns/critical-patterns.md`.
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## Quality Guidelines
|
|
82
|
-
|
|
83
|
-
- ✅ Focus on the **Why**, not just the **What**.
|
|
84
|
-
- ✅ Keep the components table updated and sorted.
|
|
85
|
-
- ✅ Link to relevant ADRs for architectural decisions.
|
|
86
|
-
- ✅ Ensure changelog entries are dated and specific.
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## References
|
|
91
|
-
|
|
92
|
-
- Template: `docs/templates/folder-readme-template.md`
|
|
93
|
-
- Tier Guide: `docs/templates/component-tier-guide.md`
|
|
94
|
-
- Documentation Map: `docs/architecture/codebase-map.md`
|
|
95
|
-
- ADRs: `docs/decisions/`
|
|
1
|
+
---
|
|
2
|
+
description: Update folder-level documentation and component changelogs. Use after modifying components or adding new ones.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /doc - Update Folder Documentation
|
|
6
|
+
|
|
7
|
+
Maintain living, component-level documentation in folder README files.
|
|
8
|
+
|
|
9
|
+
> **Why /doc?** Component-level context evaporates quickly. Documenting the "why" and "when" of changes ensures the codebase remains understandable as it grows.
|
|
10
|
+
|
|
11
|
+
## When To Use
|
|
12
|
+
|
|
13
|
+
- After modifying a component's core logic
|
|
14
|
+
- When adding a new file to a directory
|
|
15
|
+
- As a handoff step in the `/review` workflow
|
|
16
|
+
- When referencing a new ADR in a component
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Workflow
|
|
21
|
+
|
|
22
|
+
### Step 1: Identify Target Folder
|
|
23
|
+
|
|
24
|
+
Identify which folder's `README.md` needs updating.
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# If not provided, list modified folders
|
|
28
|
+
git diff main --name-only | xargs -n1 dirname | sort -u
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Step 2: Read Existing README
|
|
32
|
+
|
|
33
|
+
Check if a `README.md` exists. If not, bootstrap it using the template.
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
# Check for README
|
|
37
|
+
ls {folder_path}/README.md
|
|
38
|
+
|
|
39
|
+
# If missing, use bootstrap script
|
|
40
|
+
Call MCP `call_tool_docs_manager` { action: "bootstrap", folder: "{folder_path}" }
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Step 3: Update Components Table
|
|
44
|
+
|
|
45
|
+
If a new component was added, ensure it's in the table.
|
|
46
|
+
|
|
47
|
+
| Component | Purpose | Status |
|
|
48
|
+
|-----------|---------|--------|
|
|
49
|
+
| `NewComponent.tsx` | {Purpose} | `🏗️ Building` |
|
|
50
|
+
|
|
51
|
+
### Step 4: Add Tiered Component Details
|
|
52
|
+
|
|
53
|
+
Update the `## Component Details` section with depth based on the component's [Tier](../../docs/templates/component-tier-guide.md).
|
|
54
|
+
|
|
55
|
+
- **🔴 Critical**: Full detail (Purpose, Functionality, Tech, Error Handling, Usage).
|
|
56
|
+
- **🟡 Supporting**: Brief purpose and key exports.
|
|
57
|
+
- **🟢 Generated**: One-line description.
|
|
58
|
+
|
|
59
|
+
### Step 5: Add Changelog Entry
|
|
60
|
+
|
|
61
|
+
Document the change, including the "why" and relevant references.
|
|
62
|
+
|
|
63
|
+
```markdown
|
|
64
|
+
### {YYYY-MM-DD}
|
|
65
|
+
- {Change description} (Response to: {Link to TODO/Spec/ADR})
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Step 6: Verify Links
|
|
69
|
+
|
|
70
|
+
Ensure any newly added links to ADRs or other documentation are valid.
|
|
71
|
+
|
|
72
|
+
### Step 7: Integration Audit (Sibling Parity)
|
|
73
|
+
|
|
74
|
+
If you created a NEW folder, ensure it is covered by the validation system:
|
|
75
|
+
1. Run `Call MCP `call_tool_docs_manager` { action: "discover" }` to verify discovery.
|
|
76
|
+
2. Run `Call MCP `call_tool_docs_manager` { action: "validate", strict: false }` to verify structure.
|
|
77
|
+
3. If new patterns were established, update `docs/solutions/patterns/critical-patterns.md`.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Quality Guidelines
|
|
82
|
+
|
|
83
|
+
- ✅ Focus on the **Why**, not just the **What**.
|
|
84
|
+
- ✅ Keep the components table updated and sorted.
|
|
85
|
+
- ✅ Link to relevant ADRs for architectural decisions.
|
|
86
|
+
- ✅ Ensure changelog entries are dated and specific.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## References
|
|
91
|
+
|
|
92
|
+
- Template: `docs/templates/folder-readme-template.md`
|
|
93
|
+
- Tier Guide: `docs/templates/component-tier-guide.md`
|
|
94
|
+
- Documentation Map: `docs/architecture/codebase-map.md`
|
|
95
|
+
- ADRs: `docs/decisions/`
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: documentation-management
|
|
3
|
-
description: Guidelines on when and where to update documentation, covering READMEs, API docs, and comments.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Documentation Management
|
|
7
|
-
|
|
8
|
-
## When to Update Docs
|
|
9
|
-
|
|
10
|
-
- New features added
|
|
11
|
-
- API changes
|
|
12
|
-
- Breaking changes
|
|
13
|
-
- Configuration updates
|
|
14
|
-
|
|
15
|
-
## Documentation Locations
|
|
16
|
-
|
|
17
|
-
| File | Purpose |
|
|
18
|
-
|------|---------|
|
|
19
|
-
| `README.md` | Project overview, install |
|
|
20
|
-
| `CHANGELOG.md` | Version history |
|
|
21
|
-
| `doc.md` | Gemini CLI reference |
|
|
22
|
-
| `GEMINI.md` | AI context |
|
|
23
|
-
|
|
24
|
-
## Standards
|
|
25
|
-
|
|
26
|
-
### Code Comments
|
|
27
|
-
- JSDoc for public functions
|
|
28
|
-
- Inline comments for complex logic
|
|
29
|
-
- TODO/FIXME with issue links
|
|
30
|
-
|
|
31
|
-
### API Documentation
|
|
32
|
-
- Input/output types
|
|
33
|
-
- Error cases
|
|
34
|
-
- Examples
|
|
1
|
+
---
|
|
2
|
+
name: documentation-management
|
|
3
|
+
description: Guidelines on when and where to update documentation, covering READMEs, API docs, and comments.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation Management
|
|
7
|
+
|
|
8
|
+
## When to Update Docs
|
|
9
|
+
|
|
10
|
+
- New features added
|
|
11
|
+
- API changes
|
|
12
|
+
- Breaking changes
|
|
13
|
+
- Configuration updates
|
|
14
|
+
|
|
15
|
+
## Documentation Locations
|
|
16
|
+
|
|
17
|
+
| File | Purpose |
|
|
18
|
+
|------|---------|
|
|
19
|
+
| `README.md` | Project overview, install |
|
|
20
|
+
| `CHANGELOG.md` | Version history |
|
|
21
|
+
| `doc.md` | Gemini CLI reference |
|
|
22
|
+
| `GEMINI.md` | AI context |
|
|
23
|
+
|
|
24
|
+
## Standards
|
|
25
|
+
|
|
26
|
+
### Code Comments
|
|
27
|
+
- JSDoc for public functions
|
|
28
|
+
- Inline comments for complex logic
|
|
29
|
+
- TODO/FIXME with issue links
|
|
30
|
+
|
|
31
|
+
### API Documentation
|
|
32
|
+
- Input/output types
|
|
33
|
+
- Error cases
|
|
34
|
+
- Examples
|
|
@@ -1,146 +1,146 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Deep investigation before planning. Use for best practices, implications, and systematic analysis.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# /explore - Research and Deep Thinking
|
|
6
|
-
|
|
7
|
-
Conduct a deep, systematic pre-planning investigation to gather industry best practices, analyze multi-order effects, and understand complex problems before committing to a formal plan.
|
|
8
|
-
|
|
9
|
-
> **Why explore?** A plan built on assumptions is a liability. 30 minutes of deep exploration compounds into architectural excellence and prevents costly rework.
|
|
10
|
-
|
|
11
|
-
## When To Use
|
|
12
|
-
|
|
13
|
-
- Before any `/plan` for complex features
|
|
14
|
-
- When investigating unfamiliar technologies or patterns
|
|
15
|
-
- For bugs requiring deep root-cause analysis
|
|
16
|
-
- Anytime you think: "I need to understand this better before I decide."
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Workflow
|
|
21
|
-
|
|
22
|
-
### Step 0: Search & Log
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
// turbo
|
|
26
|
-
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/explore", outcome: "success" }
|
|
27
|
-
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "exploration"] }
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
### Step 1: Search Existing Knowledge (MANDATORY)
|
|
31
|
-
|
|
32
|
-
> [!CAUTION]
|
|
33
|
-
> **BLOCKING STEP.** Search both solutions AND prior explorations.
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
// turbo
|
|
37
|
-
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "{keywords}"] }
|
|
38
|
-
ls docs/explorations/*.md | grep "{keyword}"
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Step 1.5: Define the Question
|
|
42
|
-
|
|
43
|
-
State exactly what we are trying to understand.
|
|
44
|
-
*Example: "What is the most robust way to handle multi-session task orchestration in a stateless agentic system?"*
|
|
45
|
-
|
|
46
|
-
### Step 2: Scope & Time-box
|
|
47
|
-
|
|
48
|
-
Set boundaries to avoid rabbit holes.
|
|
49
|
-
- **Time-box:** How long will we explore? (e.g., 30m, 1h, 1 day)
|
|
50
|
-
- **Success Criteria:** What specific answer or evidence do we need?
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
### Step 3: Internet Research (Recommended)
|
|
55
|
-
|
|
56
|
-
> [!TIP]
|
|
57
|
-
> **Best Practice.** Verification of industry standards is highly encouraged.
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
// turbo
|
|
61
|
-
search_web("{topic} best practices software engineering")
|
|
62
|
-
search_web("{topic} common pitfalls and anti-patterns")
|
|
63
|
-
search_web("{topic} design patterns comparison")
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
**Summarize industry standards in the exploration artifact.**
|
|
67
|
-
|
|
68
|
-
---
|
|
69
|
-
|
|
70
|
-
### Step 4: Deep Systematic Analysis
|
|
71
|
-
|
|
72
|
-
Apply multi-order thinking and holistic analysis.
|
|
73
|
-
|
|
74
|
-
**Multi-Order Consequences ("And Then What?"):**
|
|
75
|
-
- **1st order:** Immediate impact of the potential change.
|
|
76
|
-
- **2nd order:** What depends on those changes?
|
|
77
|
-
- **3rd order:** Cascading effects (drift, technical debt).
|
|
78
|
-
- **4th order:** Long-term cultural or architectural shifts.
|
|
79
|
-
|
|
80
|
-
**Stakeholder Impact Matrix:**
|
|
81
|
-
Assess impact on End Users, Developers, Ops/Support, and Downstream Systems.
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
### Step 5: Document Findings
|
|
86
|
-
|
|
87
|
-
Create the exploration file at `docs/explorations/{topic}-{YYYYMMDD}.md`.
|
|
88
|
-
Use the template at `docs/explorations/templates/exploration-template.md`.
|
|
89
|
-
|
|
90
|
-
### Step 6: Long-Term Implications Check
|
|
91
|
-
|
|
92
|
-
- **6 months/1 year:** How will this age?
|
|
93
|
-
- **Reversibility:** Can we undo this? (Type 1 vs Type 2 decisions)
|
|
94
|
-
- **Technical Debt:** Does this create or pay down debt?
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
|
|
98
|
-
### Step 7: Decision Gate
|
|
99
|
-
|
|
100
|
-
Decide on the next logical action:
|
|
101
|
-
1. **Proceed to /plan:** We have enough understanding to build.
|
|
102
|
-
2. **Proceed to /specs:** This is a major iniciativa.
|
|
103
|
-
3. **Create Todo:** Defer based on findings.
|
|
104
|
-
4. **No Action:** Learning captured, no change needed.
|
|
105
|
-
5. **Escalate:** Needs human stakeholder input.
|
|
106
|
-
|
|
107
|
-
### Phase 5: Completion & Handoff
|
|
108
|
-
|
|
109
|
-
#### Step 1: Establish Terminal UI State
|
|
110
|
-
|
|
111
|
-
```javascript
|
|
112
|
-
await task_boundary({
|
|
113
|
-
TaskName: "[COMPLETED] Exploration: {Topic}",
|
|
114
|
-
TaskStatus: "Exploration complete. Offering next steps.",
|
|
115
|
-
Mode: "VERIFICATION",
|
|
116
|
-
TaskSummary: "Completed deep exploration of {topic}. Findings documented in docs/explorations/{filename}. Decision: {Gate Decision}."
|
|
117
|
-
});
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
#### Step 2: Mandatory Handoff
|
|
121
|
-
|
|
122
|
-
```bash
|
|
123
|
-
✓ Exploration complete
|
|
124
|
-
|
|
125
|
-
Next steps:
|
|
126
|
-
1. /plan - Create plan based on findings (if proceed)
|
|
127
|
-
2. /specs - Create specification (if major initiative)
|
|
128
|
-
3. /triage - File found issues as todos
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
---
|
|
132
|
-
|
|
133
|
-
## Quality Guidelines
|
|
134
|
-
|
|
135
|
-
- ✅ Internet search for industry standards is encouraged.
|
|
136
|
-
- ✅ Document "And Then What?" at least to 3rd order.
|
|
137
|
-
- ✅ Explicitly state when something is a "Type 1" (irreversible) decision.
|
|
138
|
-
- ✅ Link findings back to codebase patterns.
|
|
139
|
-
|
|
140
|
-
---
|
|
141
|
-
|
|
142
|
-
## References
|
|
143
|
-
|
|
144
|
-
- Explorations directory: `docs/explorations/`
|
|
145
|
-
- Solutions: `docs/solutions/`
|
|
146
|
-
- Pattern #11: Explore Before Plan
|
|
1
|
+
---
|
|
2
|
+
description: Deep investigation before planning. Use for best practices, implications, and systematic analysis.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /explore - Research and Deep Thinking
|
|
6
|
+
|
|
7
|
+
Conduct a deep, systematic pre-planning investigation to gather industry best practices, analyze multi-order effects, and understand complex problems before committing to a formal plan.
|
|
8
|
+
|
|
9
|
+
> **Why explore?** A plan built on assumptions is a liability. 30 minutes of deep exploration compounds into architectural excellence and prevents costly rework.
|
|
10
|
+
|
|
11
|
+
## When To Use
|
|
12
|
+
|
|
13
|
+
- Before any `/plan` for complex features
|
|
14
|
+
- When investigating unfamiliar technologies or patterns
|
|
15
|
+
- For bugs requiring deep root-cause analysis
|
|
16
|
+
- Anytime you think: "I need to understand this better before I decide."
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Workflow
|
|
21
|
+
|
|
22
|
+
### Step 0: Search & Log
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
// turbo
|
|
26
|
+
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/explore", outcome: "success" }
|
|
27
|
+
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "exploration"] }
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Step 1: Search Existing Knowledge (MANDATORY)
|
|
31
|
+
|
|
32
|
+
> [!CAUTION]
|
|
33
|
+
> **BLOCKING STEP.** Search both solutions AND prior explorations.
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
// turbo
|
|
37
|
+
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "{keywords}"] }
|
|
38
|
+
ls docs/explorations/*.md | grep "{keyword}"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Step 1.5: Define the Question
|
|
42
|
+
|
|
43
|
+
State exactly what we are trying to understand.
|
|
44
|
+
*Example: "What is the most robust way to handle multi-session task orchestration in a stateless agentic system?"*
|
|
45
|
+
|
|
46
|
+
### Step 2: Scope & Time-box
|
|
47
|
+
|
|
48
|
+
Set boundaries to avoid rabbit holes.
|
|
49
|
+
- **Time-box:** How long will we explore? (e.g., 30m, 1h, 1 day)
|
|
50
|
+
- **Success Criteria:** What specific answer or evidence do we need?
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
### Step 3: Internet Research (Recommended)
|
|
55
|
+
|
|
56
|
+
> [!TIP]
|
|
57
|
+
> **Best Practice.** Verification of industry standards is highly encouraged.
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
// turbo
|
|
61
|
+
search_web("{topic} best practices software engineering")
|
|
62
|
+
search_web("{topic} common pitfalls and anti-patterns")
|
|
63
|
+
search_web("{topic} design patterns comparison")
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Summarize industry standards in the exploration artifact.**
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
### Step 4: Deep Systematic Analysis
|
|
71
|
+
|
|
72
|
+
Apply multi-order thinking and holistic analysis.
|
|
73
|
+
|
|
74
|
+
**Multi-Order Consequences ("And Then What?"):**
|
|
75
|
+
- **1st order:** Immediate impact of the potential change.
|
|
76
|
+
- **2nd order:** What depends on those changes?
|
|
77
|
+
- **3rd order:** Cascading effects (drift, technical debt).
|
|
78
|
+
- **4th order:** Long-term cultural or architectural shifts.
|
|
79
|
+
|
|
80
|
+
**Stakeholder Impact Matrix:**
|
|
81
|
+
Assess impact on End Users, Developers, Ops/Support, and Downstream Systems.
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
### Step 5: Document Findings
|
|
86
|
+
|
|
87
|
+
Create the exploration file at `docs/explorations/{topic}-{YYYYMMDD}.md`.
|
|
88
|
+
Use the template at `docs/explorations/templates/exploration-template.md`.
|
|
89
|
+
|
|
90
|
+
### Step 6: Long-Term Implications Check
|
|
91
|
+
|
|
92
|
+
- **6 months/1 year:** How will this age?
|
|
93
|
+
- **Reversibility:** Can we undo this? (Type 1 vs Type 2 decisions)
|
|
94
|
+
- **Technical Debt:** Does this create or pay down debt?
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
### Step 7: Decision Gate
|
|
99
|
+
|
|
100
|
+
Decide on the next logical action:
|
|
101
|
+
1. **Proceed to /plan:** We have enough understanding to build.
|
|
102
|
+
2. **Proceed to /specs:** This is a major iniciativa.
|
|
103
|
+
3. **Create Todo:** Defer based on findings.
|
|
104
|
+
4. **No Action:** Learning captured, no change needed.
|
|
105
|
+
5. **Escalate:** Needs human stakeholder input.
|
|
106
|
+
|
|
107
|
+
### Phase 5: Completion & Handoff
|
|
108
|
+
|
|
109
|
+
#### Step 1: Establish Terminal UI State
|
|
110
|
+
|
|
111
|
+
```javascript
|
|
112
|
+
await task_boundary({
|
|
113
|
+
TaskName: "[COMPLETED] Exploration: {Topic}",
|
|
114
|
+
TaskStatus: "Exploration complete. Offering next steps.",
|
|
115
|
+
Mode: "VERIFICATION",
|
|
116
|
+
TaskSummary: "Completed deep exploration of {topic}. Findings documented in docs/explorations/{filename}. Decision: {Gate Decision}."
|
|
117
|
+
});
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
#### Step 2: Mandatory Handoff
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
✓ Exploration complete
|
|
124
|
+
|
|
125
|
+
Next steps:
|
|
126
|
+
1. /plan - Create plan based on findings (if proceed)
|
|
127
|
+
2. /specs - Create specification (if major initiative)
|
|
128
|
+
3. /triage - File found issues as todos
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Quality Guidelines
|
|
134
|
+
|
|
135
|
+
- ✅ Internet search for industry standards is encouraged.
|
|
136
|
+
- ✅ Document "And Then What?" at least to 3rd order.
|
|
137
|
+
- ✅ Explicitly state when something is a "Type 1" (irreversible) decision.
|
|
138
|
+
- ✅ Link findings back to codebase patterns.
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## References
|
|
143
|
+
|
|
144
|
+
- Explorations directory: `docs/explorations/`
|
|
145
|
+
- Solutions: `docs/solutions/`
|
|
146
|
+
- Pattern #11: Explore Before Plan
|