groundswell 0.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 (120) hide show
  1. package/.claude/settings.local.json +9 -0
  2. package/.claude/system_prompts/task-breakdown.md +100 -0
  3. package/PRPs/001-hierarchical-workflow-engine.md +2438 -0
  4. package/PRPs/PRDs/001-hierarchical-workflow-engine.md +543 -0
  5. package/PRPs/PRDs/002-agent-prompt.md +390 -0
  6. package/PRPs/PRDs/003-agent-prompt.md +943 -0
  7. package/PRPs/PRDs/004-agent-prompt.md +1136 -0
  8. package/PRPs/PRDs/tasks-001.json +492 -0
  9. package/PRPs/README.md +83 -0
  10. package/PRPs/templates/prp_base.md +222 -0
  11. package/README.md +218 -0
  12. package/docs/agent.md +422 -0
  13. package/docs/prompt.md +419 -0
  14. package/docs/workflow.md +600 -0
  15. package/examples/README.md +244 -0
  16. package/examples/examples/01-basic-workflow.ts +100 -0
  17. package/examples/examples/02-decorator-options.ts +217 -0
  18. package/examples/examples/03-parent-child.ts +241 -0
  19. package/examples/examples/04-observers-debugger.ts +340 -0
  20. package/examples/examples/05-error-handling.ts +387 -0
  21. package/examples/examples/06-concurrent-tasks.ts +352 -0
  22. package/examples/examples/07-agent-loops.ts +432 -0
  23. package/examples/examples/08-sdk-features.ts +667 -0
  24. package/examples/examples/09-reflection.ts +573 -0
  25. package/examples/examples/10-introspection.ts +550 -0
  26. package/examples/index.ts +143 -0
  27. package/examples/utils/helpers.ts +57 -0
  28. package/llms_full.txt +5890 -0
  29. package/package.json +63 -0
  30. package/plan/P1P2/PRP.md +527 -0
  31. package/plan/P1P2/research/LRU_CACHE_BEST_PRACTICES.md +1929 -0
  32. package/plan/P1P2/research/LRU_CACHE_CODE_PATTERNS.md +857 -0
  33. package/plan/P1P2/research/LRU_CACHE_INTEGRATION_GUIDE.md +738 -0
  34. package/plan/P1P2/research/LRU_CACHE_RESEARCH_INDEX.md +424 -0
  35. package/plan/P1P2/research/REFLECTION_INDEX.md +291 -0
  36. package/plan/P1P2/research/REFLECTION_RESEARCH_REPORT.md +1342 -0
  37. package/plan/P1P2/research/RESEARCH_SUMMARY.md +342 -0
  38. package/plan/P1P2/research/anthropic-sdk.md +174 -0
  39. package/plan/P1P2/research/async-local-storage.md +200 -0
  40. package/plan/P1P2/research/reflection-code-patterns.md +1205 -0
  41. package/plan/P1P2/research/reflection-decision-matrix.md +421 -0
  42. package/plan/P1P2/research/reflection-implementation-guide.md +1341 -0
  43. package/plan/P1P2/research/reflection-integration-guide.md +834 -0
  44. package/plan/P1P2/research/reflection-patterns.md +1468 -0
  45. package/plan/P1P2/research/reflection-quick-reference.md +558 -0
  46. package/plan/P1P2/research/zod-schema.md +152 -0
  47. package/plan/P3P4/PRP.md +1388 -0
  48. package/plan/P3P4/research/caching-lru.md +116 -0
  49. package/plan/P3P4/research/introspection-tools.md +177 -0
  50. package/plan/P3P4/research/reflection-patterns.md +117 -0
  51. package/plan/P4P5/PRP.md +1136 -0
  52. package/plan/P4P5/research/RESEARCH_SUMMARY.md +151 -0
  53. package/plan/architecture/external_deps.md +358 -0
  54. package/plan/architecture/system_context.md +242 -0
  55. package/plan/backlog.json +867 -0
  56. package/plan/research/INTROSPECTION_RESEARCH_SUMMARY.md +378 -0
  57. package/plan/research/README-INTROSPECTION.md +352 -0
  58. package/plan/research/agent-introspection-patterns.md +1085 -0
  59. package/plan/research/introspection-security-guide.md +928 -0
  60. package/plan/research/introspection-tool-examples.md +875 -0
  61. package/scripts/generate-llms-full.ts +206 -0
  62. package/src/__tests__/integration/agent-workflow.test.ts +256 -0
  63. package/src/__tests__/integration/tree-mirroring.test.ts +114 -0
  64. package/src/__tests__/unit/agent.test.ts +169 -0
  65. package/src/__tests__/unit/cache-key.test.ts +182 -0
  66. package/src/__tests__/unit/cache.test.ts +172 -0
  67. package/src/__tests__/unit/context.test.ts +138 -0
  68. package/src/__tests__/unit/decorators.test.ts +100 -0
  69. package/src/__tests__/unit/introspection-tools.test.ts +277 -0
  70. package/src/__tests__/unit/prompt.test.ts +135 -0
  71. package/src/__tests__/unit/reflection.test.ts +210 -0
  72. package/src/__tests__/unit/tree-debugger.test.ts +85 -0
  73. package/src/__tests__/unit/workflow.test.ts +81 -0
  74. package/src/cache/cache-key.ts +244 -0
  75. package/src/cache/cache.ts +236 -0
  76. package/src/cache/index.ts +8 -0
  77. package/src/core/agent.ts +573 -0
  78. package/src/core/context.ts +119 -0
  79. package/src/core/event-tree.ts +260 -0
  80. package/src/core/factory.ts +123 -0
  81. package/src/core/index.ts +17 -0
  82. package/src/core/logger.ts +87 -0
  83. package/src/core/mcp-handler.ts +184 -0
  84. package/src/core/prompt.ts +150 -0
  85. package/src/core/workflow-context.ts +349 -0
  86. package/src/core/workflow.ts +302 -0
  87. package/src/debugger/index.ts +1 -0
  88. package/src/debugger/tree-debugger.ts +210 -0
  89. package/src/decorators/index.ts +3 -0
  90. package/src/decorators/observed-state.ts +95 -0
  91. package/src/decorators/step.ts +139 -0
  92. package/src/decorators/task.ts +96 -0
  93. package/src/examples/index.ts +2 -0
  94. package/src/examples/tdd-orchestrator.ts +65 -0
  95. package/src/examples/test-cycle-workflow.ts +64 -0
  96. package/src/index.ts +140 -0
  97. package/src/reflection/index.ts +5 -0
  98. package/src/reflection/reflection.ts +407 -0
  99. package/src/tools/index.ts +36 -0
  100. package/src/tools/introspection.ts +464 -0
  101. package/src/types/agent.ts +90 -0
  102. package/src/types/decorators.ts +25 -0
  103. package/src/types/error-strategy.ts +13 -0
  104. package/src/types/error.ts +20 -0
  105. package/src/types/events.ts +74 -0
  106. package/src/types/index.ts +55 -0
  107. package/src/types/logging.ts +24 -0
  108. package/src/types/observer.ts +18 -0
  109. package/src/types/prompt.ts +40 -0
  110. package/src/types/reflection.ts +117 -0
  111. package/src/types/sdk-primitives.ts +128 -0
  112. package/src/types/snapshot.ts +14 -0
  113. package/src/types/workflow-context.ts +163 -0
  114. package/src/types/workflow.ts +37 -0
  115. package/src/utils/id.ts +11 -0
  116. package/src/utils/index.ts +3 -0
  117. package/src/utils/observable.ts +77 -0
  118. package/tasks.json +0 -0
  119. package/tsconfig.json +22 -0
  120. package/vitest.config.ts +16 -0
@@ -0,0 +1,1136 @@
1
+ # PRP: Phase 4 & 5 - Validation & Examples Completion
2
+
3
+ ## Phases 4 & 5 Implementation Plan
4
+
5
+ > **PRP**: Product Requirements Package - A comprehensive implementation guide enabling one-pass success
6
+
7
+ ---
8
+
9
+ ## Pre-Implementation Checklist
10
+
11
+ Before implementing, verify you have:
12
+ - [ ] Read and understood this entire PRP
13
+ - [ ] Read PRPs/PRDs/002-agent-prompt.md (main PRD - all sections)
14
+ - [ ] Read PRPs/PRDs/003-agent-prompt.md (Phases 3 & 4 PRP)
15
+ - [ ] Verified Phases 1-4 are complete (run validation commands below)
16
+ - [ ] Access to `./` codebase
17
+ - [ ] npm dependencies installed: `@anthropic-ai/sdk@^0.71.1`, `zod@^3.23.0`, `lru-cache@^10.0.0`
18
+ - [ ] Understanding of existing examples in `/examples/examples/01-06*.ts`
19
+
20
+ ---
21
+
22
+ ## Phase 4 & 5 Status Summary
23
+
24
+ ### Phase 4: Dynamic Behavior & Introspection - **COMPLETE**
25
+
26
+ All Phase 4 tasks have been implemented:
27
+
28
+ | Task | Status | Implementation File |
29
+ |------|--------|---------------------|
30
+ | P4.1: Dynamic Factory Functions | COMPLETE | `/src/core/factory.ts` |
31
+ | P4.2: Dynamic Context Revision | COMPLETE | `/src/core/workflow-context.ts` |
32
+ | P4.3: Introspection Tool Definitions | COMPLETE | `/src/tools/introspection.ts` |
33
+ | P4.4: Introspection Tool Handlers | COMPLETE | `/src/tools/introspection.ts` |
34
+ | P4.5: Main Exports Update | COMPLETE | `/src/index.ts` |
35
+
36
+ ### Phase 5: Examples - **IN PROGRESS**
37
+
38
+ | Task | Status | Implementation File |
39
+ |------|--------|---------------------|
40
+ | P5.1: Example 7 - Agent Loops | PENDING | `/examples/examples/07-agent-loops.ts` |
41
+ | P5.2: Example 8 - SDK Features | PENDING | `/examples/examples/08-sdk-features.ts` |
42
+ | P5.3: Example 9 - Multi-level Reflection | PENDING | `/examples/examples/09-reflection.ts` |
43
+ | P5.4: Example 10 - Introspection Tools | PENDING | `/examples/examples/10-introspection.ts` |
44
+ | P5.5: Update index.ts and README | PENDING | `/examples/index.ts`, `/examples/README.md` |
45
+
46
+ ---
47
+
48
+ ## 1. Goal
49
+
50
+ ### Feature Goal
51
+ Complete the Groundswell orchestration framework by:
52
+ 1. Validating all Phase 4 implementations are production-ready
53
+ 2. Creating canonical examples 7-10 demonstrating Agent loops, SDK features, reflection, and introspection
54
+ 3. Updating example runner and documentation
55
+
56
+ ### Deliverable
57
+ A complete system where:
58
+ 1. All Phase 3-4 implementations pass validation (PRD Sections 9, 10, 11)
59
+ 2. Examples 7-10 demonstrate advanced Agent/Prompt capabilities (PRD Section 12 items 7-10)
60
+ 3. Full examples runner with documentation
61
+
62
+ ### Success Definition
63
+ - [ ] `npm run build` passes with no TypeScript errors
64
+ - [ ] `npm test` passes all unit and integration tests
65
+ - [ ] Examples 7-10 execute successfully: `npx tsx examples/examples/07-agent-loops.ts`
66
+ - [ ] All 10 PRD examples listed in examples/README.md
67
+ - [ ] Cache, Reflection, and Introspection systems demonstrated in examples
68
+
69
+ ---
70
+
71
+ ## 2. Context
72
+
73
+ ### External Documentation
74
+ ```yaml
75
+ anthropic_sdk:
76
+ url: "https://github.com/anthropics/anthropic-sdk-typescript"
77
+ purpose: "Tool definitions, message API, error types"
78
+ version: "^0.71.1"
79
+ key_sections:
80
+ - "Tool Use" - https://platform.claude.com/docs/en/agents-and-tools/tool-use/implement-tool-use
81
+ - "Streaming" - https://github.com/anthropics/anthropic-sdk-typescript#streaming
82
+
83
+ lru_cache:
84
+ url: "https://www.npmjs.com/package/lru-cache"
85
+ purpose: "LRU cache implementation (already installed)"
86
+ version: "^10.0.0"
87
+
88
+ zod:
89
+ url: "https://zod.dev/"
90
+ purpose: "Schema validation for response formats"
91
+ version: "^3.23.0"
92
+ ```
93
+
94
+ ### Codebase Context
95
+ ```yaml
96
+ existing_implementations:
97
+ - file: "/src/core/agent.ts"
98
+ purpose: "Agent class with prompt(), reflect(), cache integration"
99
+ key_exports: "Agent, PromptResult"
100
+ lines: 573
101
+
102
+ - file: "/src/core/prompt.ts"
103
+ purpose: "Immutable Prompt class with Zod validation"
104
+ key_exports: "Prompt"
105
+ lines: 150
106
+
107
+ - file: "/src/core/factory.ts"
108
+ purpose: "Dynamic creation functions"
109
+ key_exports: "createWorkflow, createAgent, createPrompt, quickWorkflow, quickAgent"
110
+ lines: 124
111
+
112
+ - file: "/src/cache/cache.ts"
113
+ purpose: "LRU cache with metrics"
114
+ key_exports: "LLMCache, defaultCache, CacheConfig, CacheMetrics"
115
+ lines: 237
116
+
117
+ - file: "/src/cache/cache-key.ts"
118
+ purpose: "Deterministic cache key generation"
119
+ key_exports: "generateCacheKey, deterministicStringify, getSchemaHash"
120
+ lines: 245
121
+
122
+ - file: "/src/reflection/reflection.ts"
123
+ purpose: "ReflectionManager with retry logic"
124
+ key_exports: "ReflectionManager, executeWithReflection"
125
+ lines: 407
126
+
127
+ - file: "/src/tools/introspection.ts"
128
+ purpose: "6 introspection tools with handlers"
129
+ key_exports: "INTROSPECTION_TOOLS, INTROSPECTION_HANDLERS, all handlers"
130
+ lines: 465
131
+
132
+ - file: "/src/core/workflow-context.ts"
133
+ purpose: "WorkflowContext with step(), spawnWorkflow(), replaceLastPromptResult()"
134
+ key_exports: "WorkflowContextImpl, createWorkflowContext"
135
+ lines: 349
136
+
137
+ existing_examples:
138
+ - file: "/examples/examples/01-basic-workflow.ts"
139
+ demonstrates: "Core workflow concepts, status lifecycle, logging"
140
+
141
+ - file: "/examples/examples/02-decorator-options.ts"
142
+ demonstrates: "@Step, @Task, @ObservedState options"
143
+
144
+ - file: "/examples/examples/03-parent-child.ts"
145
+ demonstrates: "Hierarchical workflows, event propagation"
146
+
147
+ - file: "/examples/examples/04-observers-debugger.ts"
148
+ demonstrates: "WorkflowObserver, WorkflowTreeDebugger, streaming"
149
+
150
+ - file: "/examples/examples/05-error-handling.ts"
151
+ demonstrates: "WorkflowError, retry patterns, error context"
152
+
153
+ - file: "/examples/examples/06-concurrent-tasks.ts"
154
+ demonstrates: "Sequential vs concurrent, fan-out/fan-in"
155
+
156
+ naming_conventions:
157
+ files: "kebab-case.ts (e.g., 07-agent-loops.ts)"
158
+ classes: "PascalCase (e.g., DataProcessorWorkflow)"
159
+ functions: "camelCase (e.g., runAgentLoopsExample)"
160
+ tools: "snake_case (e.g., inspect_current_node)"
161
+ exports: "run*Example pattern (e.g., runAgentLoopsExample)"
162
+ ```
163
+
164
+ ### Technical Constraints
165
+ ```yaml
166
+ typescript:
167
+ version: "5.2+"
168
+ config_requirements:
169
+ - "strict: true"
170
+ - "module: NodeNext"
171
+ - "moduleResolution: NodeNext"
172
+
173
+ runtime:
174
+ node_version: "18+"
175
+ target: "ES2022"
176
+
177
+ testing:
178
+ framework: "vitest"
179
+ command: "npm test"
180
+ pattern: "describe/it/expect"
181
+
182
+ example_execution:
183
+ command: "npx tsx examples/examples/07-agent-loops.ts"
184
+ runner: "npm run start:all"
185
+ ```
186
+
187
+ ### Research References
188
+ ```yaml
189
+ caching_patterns:
190
+ file: "/plan/P3P4/research/caching-lru.md"
191
+ key_points:
192
+ - "Deterministic stringify with sorted keys"
193
+ - "LRU config: maxItems=1000, maxSizeBytes=50MB, ttl=1hr"
194
+ - "SHA-256 for cache keys (64-char hex)"
195
+ - "Schema hashing via _def (16-char prefix)"
196
+
197
+ reflection_patterns:
198
+ file: "/plan/P3P4/research/reflection-patterns.md"
199
+ key_points:
200
+ - "Three levels: workflow, agent, prompt"
201
+ - "Max 3 attempts before failure"
202
+ - "Skip reflection for rate limits, auth errors, quota exceeded"
203
+ - "Emit reflectionStart/reflectionEnd events"
204
+
205
+ introspection_tools:
206
+ file: "/plan/P3P4/research/introspection-tools.md"
207
+ key_points:
208
+ - "6 tools: inspect_current_node, read_ancestor_chain, list_siblings_children, inspect_prior_outputs, inspect_cache_status, request_spawn_workflow"
209
+ - "All tools are read-only (except spawn)"
210
+ - "Use getExecutionContext() for context access"
211
+ - "Security: filter secrets, respect boundaries"
212
+
213
+ agent_introspection_patterns:
214
+ file: "/plan/research/agent-introspection-patterns.md"
215
+ key_points:
216
+ - "HierarchyInfo with depth, position, metrics"
217
+ - "Tool definitions in Anthropic format"
218
+ - "Context-aware decision making patterns"
219
+
220
+ introspection_security:
221
+ file: "/plan/research/introspection-security-guide.md"
222
+ key_points:
223
+ - "State snapshots filtered for sensitive fields"
224
+ - "Cache tool filters credentials/secrets"
225
+ - "All queries have result limits"
226
+ ```
227
+
228
+ ---
229
+
230
+ ## 3. Implementation Validation
231
+
232
+ ### Pre-Implementation Validation Commands
233
+
234
+ Before creating examples, validate all Phase 3-4 implementations:
235
+
236
+ ```bash
237
+ # 1. Build passes
238
+ npm run build
239
+
240
+ # 2. All tests pass
241
+ npm test
242
+
243
+ # 3. Verify cache exports
244
+ node -e "
245
+ const { LLMCache, defaultCache, generateCacheKey, deterministicStringify, getSchemaHash } = require('./dist');
246
+ console.log('Cache exports:', { LLMCache: !!LLMCache, defaultCache: !!defaultCache, generateCacheKey: !!generateCacheKey });
247
+ "
248
+
249
+ # 4. Verify reflection exports
250
+ node -e "
251
+ const { ReflectionManager, executeWithReflection, DEFAULT_REFLECTION_CONFIG } = require('./dist');
252
+ console.log('Reflection exports:', { ReflectionManager: !!ReflectionManager, executeWithReflection: !!executeWithReflection });
253
+ "
254
+
255
+ # 5. Verify introspection exports
256
+ node -e "
257
+ const { INTROSPECTION_TOOLS, INTROSPECTION_HANDLERS, handleInspectCurrentNode } = require('./dist');
258
+ console.log('Introspection exports:', { INTROSPECTION_TOOLS: INTROSPECTION_TOOLS.length, handlers: !!handleInspectCurrentNode });
259
+ "
260
+
261
+ # 6. Verify factory exports
262
+ node -e "
263
+ const { createWorkflow, createAgent, createPrompt, quickWorkflow, quickAgent } = require('./dist');
264
+ console.log('Factory exports:', { createWorkflow: !!createWorkflow, createAgent: !!createAgent, createPrompt: !!createPrompt });
265
+ "
266
+
267
+ # 7. Run existing examples 1-6
268
+ npm run start:all
269
+ ```
270
+
271
+ **Expected Results**: All commands complete without errors.
272
+
273
+ ---
274
+
275
+ ## 4. Implementation Tasks
276
+
277
+ > Tasks are ordered by dependency. Complete each task fully before moving to the next.
278
+
279
+ ---
280
+
281
+ ### Task P5.1: Example 7 - Agent Loops with Observability
282
+
283
+ **Depends on**: Phase 4 validation complete
284
+
285
+ **Input**: PRD Section 12 item 7 - "Loops calling multiple agents repeatedly with full observability"
286
+
287
+ **Purpose**: Demonstrate using `Agent.prompt()` within workflow loops with full event tree capture, timing metrics, and state snapshots.
288
+
289
+ **File**: `/examples/examples/07-agent-loops.ts`
290
+
291
+ **Implementation Steps**:
292
+
293
+ 1. Create the example file with standard header:
294
+ ```typescript
295
+ /**
296
+ * Example 7: Agent Loops with Observability
297
+ *
298
+ * Demonstrates:
299
+ * - Using Agent.prompt() within ctx.step() loops
300
+ * - Multiple agents for different item types
301
+ * - Full event tree visualization with timing
302
+ * - State snapshots at each iteration
303
+ * - Cache hit/miss tracking
304
+ */
305
+ ```
306
+
307
+ 2. Import required modules:
308
+ ```typescript
309
+ import { z } from 'zod';
310
+ import {
311
+ createWorkflow,
312
+ createAgent,
313
+ createPrompt,
314
+ Agent,
315
+ Prompt,
316
+ WorkflowContext,
317
+ WorkflowTreeDebugger,
318
+ Step,
319
+ ObservedState,
320
+ getExecutionContext,
321
+ defaultCache,
322
+ } from 'groundswell';
323
+ import { printHeader, printSection, sleep } from '../utils/helpers.js';
324
+ ```
325
+
326
+ 3. Implement three-part demonstration:
327
+
328
+ **Part 1: Basic Agent Loop**
329
+ ```typescript
330
+ // Process array of items with Agent inside loop
331
+ const items = ['apple', 'banana', 'cherry'];
332
+ for (const item of items) {
333
+ await ctx.step(`process-${item}`, async () => {
334
+ const result = await agent.prompt(classifyPrompt.withData({ item }));
335
+ // Show timing, result, event emission
336
+ });
337
+ }
338
+ ```
339
+
340
+ **Part 2: Multi-Agent Loop**
341
+ ```typescript
342
+ // Different agents for different data types
343
+ const textAgent = createAgent({ name: 'TextAgent', enableCache: true });
344
+ const numberAgent = createAgent({ name: 'NumberAgent', enableCache: true });
345
+
346
+ for (const input of mixedData) {
347
+ const agent = typeof input === 'string' ? textAgent : numberAgent;
348
+ await ctx.step(`process-${input}`, async () => {
349
+ await agent.prompt(appropriatePrompt);
350
+ });
351
+ }
352
+ ```
353
+
354
+ **Part 3: Observability Metrics**
355
+ ```typescript
356
+ // Show complete event tree with timing per step
357
+ // Show cache metrics (hits/misses)
358
+ // Show state snapshots at each iteration
359
+ console.log('Tree:\n' + debugger_.toTreeString());
360
+ console.log('Cache metrics:', defaultCache.metrics());
361
+ ```
362
+
363
+ 4. Export run function:
364
+ ```typescript
365
+ export async function runAgentLoopsExample(): Promise<void> { ... }
366
+
367
+ if (import.meta.url === `file://${process.argv[1]}`) {
368
+ runAgentLoopsExample().catch(console.error);
369
+ }
370
+ ```
371
+
372
+ **Output**: Working example at `/examples/examples/07-agent-loops.ts`
373
+
374
+ **Validation**:
375
+ ```bash
376
+ npx tsx examples/examples/07-agent-loops.ts
377
+ # Expected: Shows loop execution with timing, tree visualization, cache metrics
378
+ ```
379
+
380
+ ---
381
+
382
+ ### Task P5.2: Example 8 - SDK Features (Tools, MCPs, Hooks, Skills)
383
+
384
+ **Depends on**: Task P5.1
385
+
386
+ **Input**: PRD Section 12 item 8 - "Tools, MCPs, hooks, skills usage examples"
387
+
388
+ **Purpose**: Demonstrate Anthropic SDK integration with custom tools, MCP servers, lifecycle hooks, and skills.
389
+
390
+ **File**: `/examples/examples/08-sdk-features.ts`
391
+
392
+ **Implementation Steps**:
393
+
394
+ 1. Create the example file with standard header:
395
+ ```typescript
396
+ /**
397
+ * Example 8: SDK Features Integration
398
+ *
399
+ * Demonstrates:
400
+ * - Custom tool definitions with handlers
401
+ * - MCP server configuration (inprocess)
402
+ * - Pre/Post tool hooks for logging and validation
403
+ * - Skills integration with SKILL.md content
404
+ * - Environment variable pass-through
405
+ */
406
+ ```
407
+
408
+ 2. Import required modules:
409
+ ```typescript
410
+ import { z } from 'zod';
411
+ import {
412
+ createWorkflow,
413
+ createAgent,
414
+ createPrompt,
415
+ Agent,
416
+ Prompt,
417
+ Tool,
418
+ MCPHandler,
419
+ WorkflowContext,
420
+ WorkflowTreeDebugger,
421
+ } from 'groundswell';
422
+ import type { AgentHooks, PreToolUseContext, PostToolUseContext } from 'groundswell';
423
+ import { printHeader, printSection } from '../utils/helpers.js';
424
+ ```
425
+
426
+ 3. Implement five-part demonstration:
427
+
428
+ **Part 1: Custom Tool Definition**
429
+ ```typescript
430
+ const calculatorTool: Tool = {
431
+ name: 'calculate',
432
+ description: 'Performs basic arithmetic',
433
+ input_schema: {
434
+ type: 'object',
435
+ properties: {
436
+ operation: { type: 'string', enum: ['add', 'subtract', 'multiply', 'divide'] },
437
+ a: { type: 'number' },
438
+ b: { type: 'number' }
439
+ },
440
+ required: ['operation', 'a', 'b']
441
+ }
442
+ };
443
+
444
+ // Handler implementation
445
+ async function handleCalculate(input: { operation: string; a: number; b: number }) {
446
+ switch (input.operation) {
447
+ case 'add': return { result: input.a + input.b };
448
+ case 'subtract': return { result: input.a - input.b };
449
+ // ...
450
+ }
451
+ }
452
+ ```
453
+
454
+ **Part 2: MCP Server Configuration**
455
+ ```typescript
456
+ const mcpHandler = new MCPHandler();
457
+ mcpHandler.registerTool(calculatorTool, handleCalculate);
458
+
459
+ const agent = createAgent({
460
+ name: 'ToolAgent',
461
+ tools: mcpHandler.getTools(),
462
+ });
463
+ ```
464
+
465
+ **Part 3: Lifecycle Hooks**
466
+ ```typescript
467
+ const hooks: AgentHooks = {
468
+ preToolUse: [
469
+ async (ctx: PreToolUseContext) => {
470
+ console.log(`[PRE] Tool: ${ctx.toolName}, Input:`, ctx.input);
471
+ // Validation logic
472
+ }
473
+ ],
474
+ postToolUse: [
475
+ async (ctx: PostToolUseContext) => {
476
+ console.log(`[POST] Tool: ${ctx.toolName}, Output:`, ctx.output);
477
+ // Logging, metrics
478
+ }
479
+ ],
480
+ sessionStart: [
481
+ async (ctx) => console.log('[SESSION START]', ctx)
482
+ ],
483
+ sessionEnd: [
484
+ async (ctx) => console.log('[SESSION END]', ctx)
485
+ ]
486
+ };
487
+ ```
488
+
489
+ **Part 4: Skills Integration**
490
+ ```typescript
491
+ // Demonstrate skill content injection into system prompt
492
+ const agent = createAgent({
493
+ name: 'SkilledAgent',
494
+ skills: [
495
+ { name: 'math', path: './skills/math' }
496
+ ]
497
+ });
498
+ // Shows SKILL.md content in system prompt
499
+ ```
500
+
501
+ **Part 5: Environment Variables**
502
+ ```typescript
503
+ const agent = createAgent({
504
+ name: 'EnvAgent',
505
+ env: {
506
+ API_KEY: 'demo-key',
507
+ DEBUG: 'true'
508
+ }
509
+ });
510
+ // Shows env vars passed through during execution
511
+ ```
512
+
513
+ 4. Export run function:
514
+ ```typescript
515
+ export async function runSDKFeaturesExample(): Promise<void> { ... }
516
+ ```
517
+
518
+ **Output**: Working example at `/examples/examples/08-sdk-features.ts`
519
+
520
+ **Validation**:
521
+ ```bash
522
+ npx tsx examples/examples/08-sdk-features.ts
523
+ # Expected: Shows tool calls with hooks, MCP integration, skill loading
524
+ ```
525
+
526
+ ---
527
+
528
+ ### Task P5.3: Example 9 - Multi-level Reflection
529
+
530
+ **Depends on**: Task P5.2
531
+
532
+ **Input**: PRD Section 12 item 9 - "Reflection at each level (Workflow, Agent, Prompt)"
533
+
534
+ **Purpose**: Demonstrate reflection capabilities at all three levels with automatic retry and error recovery.
535
+
536
+ **File**: `/examples/examples/09-reflection.ts`
537
+
538
+ **Implementation Steps**:
539
+
540
+ 1. Create the example file with standard header:
541
+ ```typescript
542
+ /**
543
+ * Example 9: Multi-level Reflection
544
+ *
545
+ * Demonstrates:
546
+ * - Prompt-level reflection (enableReflection on prompt)
547
+ * - Agent-level reflection (agent.reflect() method)
548
+ * - Workflow-level reflection (step failure retry)
549
+ * - Reflection events in tree output
550
+ * - Error recovery with revised prompts
551
+ */
552
+ ```
553
+
554
+ 2. Import required modules:
555
+ ```typescript
556
+ import { z } from 'zod';
557
+ import {
558
+ createWorkflow,
559
+ createAgent,
560
+ createPrompt,
561
+ Agent,
562
+ Prompt,
563
+ WorkflowContext,
564
+ WorkflowTreeDebugger,
565
+ ReflectionManager,
566
+ executeWithReflection,
567
+ DEFAULT_REFLECTION_CONFIG,
568
+ } from 'groundswell';
569
+ import type { ReflectionConfig, ReflectionEntry } from 'groundswell';
570
+ import { printHeader, printSection, simulateUnreliableTask } from '../utils/helpers.js';
571
+ ```
572
+
573
+ 3. Implement three-part demonstration:
574
+
575
+ **Part 1: Prompt-Level Reflection**
576
+ ```typescript
577
+ // Schema validation fails, triggers reflection
578
+ const strictSchema = z.object({
579
+ answer: z.string().min(10),
580
+ confidence: z.number().min(0.8)
581
+ });
582
+
583
+ const prompt = createPrompt({
584
+ user: 'Provide a brief answer',
585
+ responseFormat: strictSchema,
586
+ enableReflection: true // Auto-reflect on validation failure
587
+ });
588
+
589
+ // First attempt may fail schema, reflection retries with adjusted output
590
+ const result = await agent.prompt(prompt);
591
+ ```
592
+
593
+ **Part 2: Agent-Level Reflection**
594
+ ```typescript
595
+ // Explicit reflection call for reasoning review
596
+ const complexPrompt = createPrompt({
597
+ user: 'Analyze this complex scenario...',
598
+ responseFormat: analysisSchema
599
+ });
600
+
601
+ // Agent reviews its own reasoning before final answer
602
+ const result = await agent.reflect(complexPrompt, {
603
+ enableReflection: true
604
+ });
605
+ // Shows reflection system prompt prefix added
606
+ ```
607
+
608
+ **Part 3: Workflow-Level Reflection**
609
+ ```typescript
610
+ const workflow = createWorkflow(
611
+ { name: 'ReflectiveWorkflow', enableReflection: true },
612
+ async (ctx) => {
613
+ let attemptCount = 0;
614
+
615
+ await ctx.step('unreliable-operation', async () => {
616
+ attemptCount++;
617
+ if (attemptCount < 3) {
618
+ throw new Error('Transient failure - please retry');
619
+ }
620
+ return 'Success on attempt 3';
621
+ });
622
+
623
+ // Shows: reflectionStart, retry, reflectionEnd events in tree
624
+ }
625
+ );
626
+
627
+ // Display reflection history
628
+ const history = ctx.reflection.getReflectionHistory();
629
+ console.log('Reflection history:', history);
630
+ ```
631
+
632
+ 4. Show reflection events in tree:
633
+ ```typescript
634
+ console.log('Tree with reflection events:\n' + debugger_.toTreeString());
635
+ // Shows: reflectionStart, reflectionEnd nodes in tree
636
+ ```
637
+
638
+ **Output**: Working example at `/examples/examples/09-reflection.ts`
639
+
640
+ **Validation**:
641
+ ```bash
642
+ npx tsx examples/examples/09-reflection.ts
643
+ # Expected: Shows reflection at all three levels, retry behavior, events in tree
644
+ ```
645
+
646
+ ---
647
+
648
+ ### Task P5.4: Example 10 - Introspection Tools Demo
649
+
650
+ **Depends on**: Task P5.3
651
+
652
+ **Input**: PRD Section 12 item 10 - "Introspection tools demo"
653
+
654
+ **Purpose**: Demonstrate agents using introspection tools to navigate and understand workflow hierarchy.
655
+
656
+ **File**: `/examples/examples/10-introspection.ts`
657
+
658
+ **Implementation Steps**:
659
+
660
+ 1. Create the example file with standard header:
661
+ ```typescript
662
+ /**
663
+ * Example 10: Introspection Tools Demo
664
+ *
665
+ * Demonstrates:
666
+ * - Agent with INTROSPECTION_TOOLS
667
+ * - inspect_current_node - "Where am I?"
668
+ * - read_ancestor_chain - "What's above me?"
669
+ * - list_siblings_children - "What's around me?"
670
+ * - inspect_prior_outputs - "What happened before?"
671
+ * - inspect_cache_status - "Is this cached?"
672
+ * - request_spawn_workflow - "Can I create children?"
673
+ */
674
+ ```
675
+
676
+ 2. Import required modules:
677
+ ```typescript
678
+ import { z } from 'zod';
679
+ import {
680
+ createWorkflow,
681
+ createAgent,
682
+ createPrompt,
683
+ Agent,
684
+ WorkflowContext,
685
+ WorkflowTreeDebugger,
686
+ INTROSPECTION_TOOLS,
687
+ INTROSPECTION_HANDLERS,
688
+ handleInspectCurrentNode,
689
+ handleReadAncestorChain,
690
+ handleListSiblingsChildren,
691
+ handleInspectPriorOutputs,
692
+ handleInspectCacheStatus,
693
+ handleRequestSpawnWorkflow,
694
+ runInContext,
695
+ getExecutionContext,
696
+ } from 'groundswell';
697
+ import type { CurrentNodeInfo, AncestorChainResult } from 'groundswell';
698
+ import { printHeader, printSection, prettyJson } from '../utils/helpers.js';
699
+ ```
700
+
701
+ 3. Implement six-part demonstration:
702
+
703
+ **Part 1: Setup Nested Hierarchy**
704
+ ```typescript
705
+ // Create 3-level nested workflow for introspection
706
+ const rootWorkflow = createWorkflow(
707
+ { name: 'RootWorkflow' },
708
+ async (ctx) => {
709
+ await ctx.step('setup', async () => { ... });
710
+
711
+ await ctx.spawnWorkflow(createWorkflow(
712
+ { name: 'ChildWorkflow' },
713
+ async (childCtx) => {
714
+ await childCtx.step('child-work', async () => {
715
+ // Agent with introspection runs here
716
+ });
717
+ }
718
+ ));
719
+ }
720
+ );
721
+ ```
722
+
723
+ **Part 2: inspect_current_node**
724
+ ```typescript
725
+ await ctx.step('where-am-i', async () => {
726
+ const nodeInfo = await handleInspectCurrentNode();
727
+ console.log('Current node:', prettyJson(nodeInfo));
728
+ // Shows: id, name, status, parentId, parentName, childCount, depth
729
+ });
730
+ ```
731
+
732
+ **Part 3: read_ancestor_chain**
733
+ ```typescript
734
+ await ctx.step('whats-above-me', async () => {
735
+ const ancestors = await handleReadAncestorChain({ maxDepth: 10 });
736
+ console.log('Ancestors:', prettyJson(ancestors));
737
+ // Shows: array of ancestor nodes from current to root
738
+ });
739
+ ```
740
+
741
+ **Part 4: list_siblings_children**
742
+ ```typescript
743
+ await ctx.step('whats-around-me', async () => {
744
+ const siblings = await handleListSiblingsChildren({ type: 'siblings' });
745
+ const children = await handleListSiblingsChildren({ type: 'children' });
746
+ console.log('Siblings:', siblings);
747
+ console.log('Children:', children);
748
+ });
749
+ ```
750
+
751
+ **Part 5: inspect_prior_outputs**
752
+ ```typescript
753
+ await ctx.step('what-happened-before', async () => {
754
+ const outputs = await handleInspectPriorOutputs({ count: 3 });
755
+ console.log('Prior outputs:', prettyJson(outputs));
756
+ // Shows: results from previous steps
757
+ });
758
+ ```
759
+
760
+ **Part 6: Agent Using All Tools**
761
+ ```typescript
762
+ // Agent with all introspection tools
763
+ const introspectionAgent = createAgent({
764
+ name: 'IntrospectionAgent',
765
+ tools: INTROSPECTION_TOOLS,
766
+ system: `You are an agent that can explore workflow hierarchies.
767
+ Use the introspection tools to understand your position
768
+ and what work has been done.`
769
+ });
770
+
771
+ const explorePrompt = createPrompt({
772
+ user: 'Describe your current position in the workflow hierarchy and summarize what work has been done.',
773
+ responseFormat: z.object({
774
+ position: z.string(),
775
+ depth: z.number(),
776
+ parentName: z.string().optional(),
777
+ summary: z.string()
778
+ })
779
+ });
780
+
781
+ // Agent uses tools to explore, then responds
782
+ const analysis = await introspectionAgent.prompt(explorePrompt);
783
+ console.log('Agent analysis:', analysis);
784
+ ```
785
+
786
+ **Output**: Working example at `/examples/examples/10-introspection.ts`
787
+
788
+ **Validation**:
789
+ ```bash
790
+ npx tsx examples/examples/10-introspection.ts
791
+ # Expected: Shows agent using all 6 introspection tools in nested workflow
792
+ ```
793
+
794
+ ---
795
+
796
+ ### Task P5.5: Update Examples Index and README
797
+
798
+ **Depends on**: Tasks P5.1-P5.4
799
+
800
+ **Input**: Existing `/examples/index.ts` and `/examples/README.md`
801
+
802
+ **Purpose**: Integrate examples 7-10 into the runner and documentation.
803
+
804
+ **Files**:
805
+ - `/examples/index.ts`
806
+ - `/examples/README.md`
807
+
808
+ **Implementation Steps**:
809
+
810
+ 1. Update `/examples/index.ts`:
811
+ ```typescript
812
+ // Add imports
813
+ import { runAgentLoopsExample } from './examples/07-agent-loops.js';
814
+ import { runSDKFeaturesExample } from './examples/08-sdk-features.js';
815
+ import { runReflectionExample } from './examples/09-reflection.js';
816
+ import { runIntrospectionExample } from './examples/10-introspection.js';
817
+
818
+ // Update MENU
819
+ const MENU = `
820
+ Available Examples:
821
+ ───────────────────────────────────────────────────────────────────
822
+ 1. Basic Workflow - Core workflow concepts
823
+ 2. Decorator Options - All @Step, @Task, @ObservedState options
824
+ 3. Parent-Child Workflows - Hierarchical workflow structures
825
+ 4. Observers & Debugger - Real-time monitoring and debugging
826
+ 5. Error Handling - Error wrapping, recovery patterns
827
+ 6. Concurrent Tasks - Parallel execution patterns
828
+ 7. Agent Loops - Agent.prompt() in loops with observability
829
+ 8. SDK Features - Tools, MCPs, hooks, skills
830
+ 9. Multi-level Reflection - Workflow, agent, prompt reflection
831
+ 10. Introspection Tools - Agent self-awareness and hierarchy navigation
832
+
833
+ A. Run All Examples
834
+ Q. Quit
835
+ ───────────────────────────────────────────────────────────────────
836
+ `;
837
+
838
+ // Update examples array in runAllExamples()
839
+ const examples = [
840
+ { name: '1. Basic Workflow', fn: runBasicWorkflowExample },
841
+ { name: '2. Decorator Options', fn: runDecoratorOptionsExample },
842
+ { name: '3. Parent-Child Workflows', fn: runParentChildExample },
843
+ { name: '4. Observers & Debugger', fn: runObserversDebuggerExample },
844
+ { name: '5. Error Handling', fn: runErrorHandlingExample },
845
+ { name: '6. Concurrent Tasks', fn: runConcurrentTasksExample },
846
+ { name: '7. Agent Loops', fn: runAgentLoopsExample },
847
+ { name: '8. SDK Features', fn: runSDKFeaturesExample },
848
+ { name: '9. Multi-level Reflection', fn: runReflectionExample },
849
+ { name: '10. Introspection Tools', fn: runIntrospectionExample },
850
+ ];
851
+
852
+ // Update Summary
853
+ console.log(`
854
+ Summary of Features Demonstrated:
855
+ ─────────────────────────────────
856
+ ✓ Workflow base class with status management
857
+ ✓ WorkflowLogger with structured logging
858
+ ✓ @Step decorator with all options
859
+ ✓ @Task decorator with concurrent option
860
+ ✓ @ObservedState decorator with hidden and redact options
861
+ ✓ Parent-child workflow hierarchies
862
+ ✓ Automatic child attachment via constructor
863
+ ✓ Event propagation to root observers
864
+ ✓ WorkflowTreeDebugger with ASCII tree visualization
865
+ ✓ Custom WorkflowObserver implementations
866
+ ✓ Observable event streaming
867
+ ✓ WorkflowError with full context
868
+ ✓ Error recovery patterns
869
+ ✓ Sequential vs parallel execution
870
+ ✓ Agent.prompt() in loops with full observability
871
+ ✓ Custom tools, MCPs, hooks, skills integration
872
+ ✓ Multi-level reflection (workflow, agent, prompt)
873
+ ✓ Introspection tools for hierarchy navigation
874
+ ✓ Cache integration with metrics
875
+ `);
876
+ ```
877
+
878
+ 2. Update `/examples/README.md`:
879
+
880
+ Add sections for examples 7-10:
881
+ ```markdown
882
+ ## 7. Agent Loops with Observability
883
+
884
+ Run: `npx tsx examples/examples/07-agent-loops.ts`
885
+
886
+ Demonstrates:
887
+ - Using Agent.prompt() within ctx.step() loops
888
+ - Multiple agents for different item types
889
+ - Full event tree visualization with timing
890
+ - State snapshots at each iteration
891
+ - Cache hit/miss tracking
892
+
893
+ ## 8. SDK Features Integration
894
+
895
+ Run: `npx tsx examples/examples/08-sdk-features.ts`
896
+
897
+ Demonstrates:
898
+ - Custom tool definitions with handlers
899
+ - MCP server configuration (inprocess)
900
+ - Pre/Post tool hooks for logging and validation
901
+ - Skills integration
902
+ - Environment variable pass-through
903
+
904
+ ## 9. Multi-level Reflection
905
+
906
+ Run: `npx tsx examples/examples/09-reflection.ts`
907
+
908
+ Demonstrates:
909
+ - Prompt-level reflection (enableReflection on prompt)
910
+ - Agent-level reflection (agent.reflect() method)
911
+ - Workflow-level reflection (step failure retry)
912
+ - Reflection events in tree output
913
+
914
+ ## 10. Introspection Tools Demo
915
+
916
+ Run: `npx tsx examples/examples/10-introspection.ts`
917
+
918
+ Demonstrates:
919
+ - Agent with INTROSPECTION_TOOLS
920
+ - inspect_current_node, read_ancestor_chain
921
+ - list_siblings_children, inspect_prior_outputs
922
+ - inspect_cache_status, request_spawn_workflow
923
+ - Agent self-awareness patterns
924
+ ```
925
+
926
+ 3. Update package.json scripts:
927
+ ```json
928
+ {
929
+ "scripts": {
930
+ "start:agent-loops": "tsx examples/examples/07-agent-loops.ts",
931
+ "start:sdk-features": "tsx examples/examples/08-sdk-features.ts",
932
+ "start:reflection": "tsx examples/examples/09-reflection.ts",
933
+ "start:introspection": "tsx examples/examples/10-introspection.ts"
934
+ }
935
+ }
936
+ ```
937
+
938
+ **Output**: Updated index, README, and package.json
939
+
940
+ **Validation**:
941
+ ```bash
942
+ npm run start:all
943
+ # Expected: All 10 examples run successfully
944
+ ```
945
+
946
+ ---
947
+
948
+ ## 5. Testing Strategy
949
+
950
+ ### Unit Tests (Already Exist)
951
+
952
+ ```yaml
953
+ existing_tests:
954
+ - path: "/src/__tests__/unit/cache-key.test.ts"
955
+ validates: "Deterministic key generation"
956
+
957
+ - path: "/src/__tests__/unit/cache.test.ts"
958
+ validates: "LRU cache operations"
959
+
960
+ - path: "/src/__tests__/unit/reflection.test.ts"
961
+ validates: "ReflectionManager behavior"
962
+
963
+ - path: "/src/__tests__/unit/introspection-tools.test.ts"
964
+ validates: "All 6 introspection tool handlers"
965
+ ```
966
+
967
+ ### Integration Tests (Already Exist)
968
+
969
+ ```yaml
970
+ existing_tests:
971
+ - path: "/src/__tests__/integration/agent-workflow.test.ts"
972
+ validates: "Agent integration with workflow context"
973
+
974
+ - path: "/src/__tests__/integration/tree-mirroring.test.ts"
975
+ validates: "Event tree hierarchy"
976
+ ```
977
+
978
+ ### Example Validation
979
+
980
+ ```yaml
981
+ manual_validation:
982
+ - example: "07-agent-loops.ts"
983
+ expected: "Loop executes, tree shows timing per step, cache metrics displayed"
984
+
985
+ - example: "08-sdk-features.ts"
986
+ expected: "Tools called with hooks logging, MCP integration shown"
987
+
988
+ - example: "09-reflection.ts"
989
+ expected: "Reflection at all levels, retry on failure, events in tree"
990
+
991
+ - example: "10-introspection.ts"
992
+ expected: "Agent describes position, uses all 6 tools, hierarchy navigation"
993
+ ```
994
+
995
+ ---
996
+
997
+ ## 6. Final Validation Checklist
998
+
999
+ ### Code Quality
1000
+ - [ ] All TypeScript compiles without errors: `npm run build`
1001
+ - [ ] No linting warnings: `npm run lint`
1002
+ - [ ] Examples follow existing patterns (check 01-06)
1003
+ - [ ] Proper imports with `.js` extensions
1004
+ - [ ] JSDoc header comments on all examples
1005
+
1006
+ ### Functionality
1007
+ - [ ] Example 7 shows agent loops with timing
1008
+ - [ ] Example 8 shows tools, MCPs, hooks, skills
1009
+ - [ ] Example 9 shows three levels of reflection
1010
+ - [ ] Example 10 shows all 6 introspection tools
1011
+ - [ ] All examples produce console output demonstrating features
1012
+
1013
+ ### Integration
1014
+ - [ ] Examples run individually: `npx tsx examples/examples/07-*.ts`
1015
+ - [ ] Examples run via runner: `npm run start:all`
1016
+ - [ ] README documents all 10 examples
1017
+ - [ ] Package.json has scripts for examples 7-10
1018
+
1019
+ ### Documentation
1020
+ - [ ] Each example has JSDoc header
1021
+ - [ ] Each example uses printHeader/printSection for output
1022
+ - [ ] README sections match example implementations
1023
+
1024
+ ---
1025
+
1026
+ ## 7. File Structure Summary
1027
+
1028
+ ```
1029
+ /examples/
1030
+ ├── index.ts # MODIFY: Add examples 7-10
1031
+ ├── README.md # MODIFY: Document examples 7-10
1032
+ ├── utils/
1033
+ │ └── helpers.ts # EXISTING: No changes needed
1034
+ └── examples/
1035
+ ├── 01-basic-workflow.ts # EXISTING
1036
+ ├── 02-decorator-options.ts # EXISTING
1037
+ ├── 03-parent-child.ts # EXISTING
1038
+ ├── 04-observers-debugger.ts# EXISTING
1039
+ ├── 05-error-handling.ts # EXISTING
1040
+ ├── 06-concurrent-tasks.ts # EXISTING
1041
+ ├── 07-agent-loops.ts # NEW: Task P5.1
1042
+ ├── 08-sdk-features.ts # NEW: Task P5.2
1043
+ ├── 09-reflection.ts # NEW: Task P5.3
1044
+ └── 10-introspection.ts # NEW: Task P5.4
1045
+
1046
+ /package.json # MODIFY: Add example scripts
1047
+ ```
1048
+
1049
+ ---
1050
+
1051
+ ## 8. "No Prior Knowledge" Test
1052
+
1053
+ **Validation**: If someone knew nothing about this codebase, would they have everything needed to implement this successfully using only this PRP?
1054
+
1055
+ - [x] All file paths are absolute and specific
1056
+ - [x] All patterns have concrete code examples
1057
+ - [x] All dependencies are explicitly listed with versions
1058
+ - [x] All validation steps are executable commands
1059
+ - [x] No assumed knowledge of codebase internals
1060
+ - [x] Existing example patterns documented for reference
1061
+ - [x] Import statements show exact module paths
1062
+ - [x] Research documents referenced for background context
1063
+
1064
+ ---
1065
+
1066
+ ## Confidence Score: 9/10
1067
+
1068
+ **Strengths:**
1069
+ - All Phase 3-4 implementations are complete and tested
1070
+ - Clear existing example patterns to follow (examples 1-6)
1071
+ - Comprehensive research documents exist for all features
1072
+ - Specific code patterns provided for each example
1073
+ - Validation commands provided at each step
1074
+
1075
+ **Risks:**
1076
+ - Examples require actual Anthropic API calls (may need mocking)
1077
+ - Introspection tools demo depends on context being properly set
1078
+ - Example complexity may need iteration for clarity
1079
+
1080
+ **Mitigations:**
1081
+ - Use `simulateApiCall` for demo purposes
1082
+ - Test introspection in actual workflow context
1083
+ - Follow existing example structure for consistency
1084
+ - Keep examples focused on demonstrating specific features
1085
+
1086
+ ---
1087
+
1088
+ ## Appendix: Example Template
1089
+
1090
+ ```typescript
1091
+ /**
1092
+ * Example N: Feature Name
1093
+ *
1094
+ * Demonstrates:
1095
+ * - Feature 1
1096
+ * - Feature 2
1097
+ * - Feature 3
1098
+ */
1099
+
1100
+ import { z } from 'zod';
1101
+ import {
1102
+ createWorkflow,
1103
+ createAgent,
1104
+ createPrompt,
1105
+ WorkflowTreeDebugger,
1106
+ // ... other imports
1107
+ } from 'groundswell';
1108
+ import { printHeader, printSection, sleep } from '../utils/helpers.js';
1109
+
1110
+ /**
1111
+ * Main example runner
1112
+ */
1113
+ export async function runExampleName(): Promise<void> {
1114
+ printHeader('Example N: Feature Name');
1115
+
1116
+ // Part 1: Basic demonstration
1117
+ printSection('Part 1: Basic Usage');
1118
+ {
1119
+ // Implementation
1120
+ }
1121
+
1122
+ // Part 2: Advanced usage
1123
+ printSection('Part 2: Advanced Patterns');
1124
+ {
1125
+ // Implementation
1126
+ }
1127
+
1128
+ // Summary
1129
+ console.log('\n=== Example Complete ===');
1130
+ }
1131
+
1132
+ // Allow direct execution
1133
+ if (import.meta.url === `file://${process.argv[1]}`) {
1134
+ runExampleName().catch(console.error);
1135
+ }
1136
+ ```