The docs follow Diátaxis: a tutorial to learn, how-to guides to get a task done, reference to look things up, and explanation to understand the design.
Start here if you are new to the SDK.
- Your first Slack bot — zero to a running Slack bot in under 30 minutes, over Socket Mode with no public URL.
For people who already have a bot running.
- Choose a state backend — memory, Redis, Postgres, or NATS JetStream.
- Defer long-running work (ack-then-work) — acknowledge deliveries fast and run handlers on a detached context.
- Handle slash commands — route Slack slash
commands through
OnCommand. - Handle interactive components — buttons, menus, Block Kit content, and modals.
- Install into multiple workspaces (multi-tenant) —
resolve per-tenant credentials with an
InstallStore. - Run Linear agent sessions — build a Linear agent with thoughts, responses, actions, elicitations, and plans.
- Reference — modules and packages, how the runtime behaves (deliveries, routing, dispatch, state, concurrency, messages, history), what each adapter supports, and the runnable examples. The API itself is in the GoDoc.
- Linear agent capabilities — what the Linear adapter supports today and what it does not wrap yet.
- Architecture and design decisions — the model in brief,
design goals, the Vercel Chat SDK concept map, non-goals, and intentional
gaps, with an index of the ADRs and
CONTEXT.md, the project's vocabulary.
CONTRIBUTING.md— how to build, test, and propose changes to this repository.docs/agents/— instructions for coding agents working on this repository, not for SDK users.