AGENTS.md

1# dbos-typescript
2 
3> **Note:** `CLAUDE.md` is a symlink to this file.
4 
5## Overview
6 
7DBOS TypeScript SDK for building reliable, fault-tolerant applications with durable workflows. Use this skill when writing TypeScript code with DBOS, creating workflows and steps, using queues, using DBOSClient from external applications, or building applications that need to be resilient to failures.
8 
9## Structure
10 
11```
12dbos-typescript/
13  SKILL.md       # Main skill file - read this first
14  AGENTS.md      # This navigation guide
15  CLAUDE.md      # Symlink to AGENTS.md
16  references/    # Detailed reference files
17```
18 
19## Usage
20 
211. Read `SKILL.md` for the main skill instructions
222. Browse `references/` for detailed documentation on specific topics
233. Reference files are loaded on-demand - read only what you need
24 
25## Reference Categories
26 
27| Priority | Category | Impact | Prefix |
28|----------|----------|--------|--------|
29| 1 | Lifecycle | CRITICAL | `lifecycle-` |
30| 2 | Workflow | CRITICAL | `workflow-` |
31| 3 | Step | HIGH | `step-` |
32| 4 | Queue | HIGH | `queue-` |
33| 5 | Communication | MEDIUM | `comm-` |
34| 6 | Pattern | MEDIUM | `pattern-` |
35| 7 | Testing | LOW-MEDIUM | `test-` |
36| 8 | Client | MEDIUM | `client-` |
37| 9 | Advanced | LOW | `advanced-` |
38 
39Reference files are named `{prefix}-{topic}.md` (e.g., `query-missing-indexes.md`).
40 
41## Available References
42 
43**Advanced** (`advanced-`):
44- `references/advanced-patching.md`
45- `references/advanced-versioning.md`
46 
47**Client** (`client-`):
48- `references/client-enqueue.md`
49- `references/client-setup.md`
50 
51**Communication** (`comm-`):
52- `references/comm-events.md`
53- `references/comm-messages.md`
54- `references/comm-streaming.md`
55 
56**Lifecycle** (`lifecycle-`):
57- `references/lifecycle-config.md`
58- `references/lifecycle-express.md`
59 
60**Pattern** (`pattern-`):
61- `references/pattern-classes.md`
62- `references/pattern-debouncing.md`
63- `references/pattern-idempotency.md`
64- `references/pattern-scheduled.md`
65- `references/pattern-sleep.md`
66 
67**Queue** (`queue-`):
68- `references/queue-basics.md`
69- `references/queue-concurrency.md`
70- `references/queue-deduplication.md`
71- `references/queue-listening.md`
72- `references/queue-partitioning.md`
73- `references/queue-priority.md`
74- `references/queue-rate-limiting.md`
75 
76**Step** (`step-`):
77- `references/step-basics.md`
78- `references/step-retries.md`
79- `references/step-transactions.md`
80 
81**Testing** (`test-`):
82- `references/test-setup.md`
83 
84**Workflow** (`workflow-`):
85- `references/workflow-background.md`
86- `references/workflow-constraints.md`
87- `references/workflow-control.md`
88- `references/workflow-determinism.md`
89- `references/workflow-introspection.md`
90- `references/workflow-timeout.md`
91 
92---
93 
94*31 reference files across 9 categories*