How vercel/chat works
Chat SDK is a TypeScript toolkit for writing chat bots once and connecting them to multiple messaging platforms. The principal runtime path is a platform event entering an adapter, reaching the bot’s Chat handlers, and producing a reply through an adapter; configured state is a separate persistence capability. Platform adapters also implement platform-specific cards and formatting. The README documents the CLI scaffold and adapter catalog as additional product capabilities. Relationships for unsampled subsystems are limited to documented links and source-index references.
Main entry points: chat.ts Chat runtime · program.ts Project scaffolder · cards.ts Discord cards · workspace-events.ts Workspace events
Components 29
Bot Runtime
- Chat runtime
packages/chat/src/chat.ts - Event handlers
packages/chat/src/context.ts - History and prompts
packages/chat/src/history/index.ts - AI tools and streaming
packages/chat/src/ai/index.ts - Workflow approvals
packages/chat/src/workflow/index.ts
Platform Adapters
- Discord cards
packages/adapter-discord/src/cards.ts - Discord formatting
packages/adapter-discord/src/markdown.ts - Google Chat cards
packages/adapter-gchat/src/cards.ts - Google Chat users
packages/adapter-gchat/src/user-info.ts - Workspace events
packages/adapter-gchat/src/workspace-events.ts - GitHub cards
packages/adapter-github/src/cards.ts - Messenger cards
packages/adapter-messenger/src/cards.ts - Teams API client
packages/adapter-teams/src/api/client.ts - Telegram formatting
packages/adapter-telegram/src/markdown.ts - Telegram rich text
packages/adapter-telegram/src/rich.ts - Telegram splitting
packages/adapter-telegram/src/split.ts - Twilio content
packages/adapter-twilio/src/api/content.ts - Twilio cards
packages/adapter-twilio/src/cards.ts - WhatsApp cards
packages/adapter-whatsapp/src/cards.ts - WhatsApp formatting
packages/adapter-whatsapp/src/markdown.ts
Catalog and Setup
- Adapter catalog
packages/catalog/src/index.ts - Project scaffolder
packages/create-chat-sdk/src/cli/program.ts - Agent detection
packages/create-chat-sdk/src/cli/agent.ts
State Backends
- Memory state
packages/state-memory/src/index.ts - Redis state
packages/state-redis/src/index.ts - Postgres state
packages/state-pg/src/index.ts - ioredis state
packages/state-ioredis/src/index.ts
Other components
- Bot developer
- Chat platforms
Connections 19
- Bot developer → Chat runtime: configures bot
- Chat platforms → Chat runtime: sends events
- Chat runtime → Event handlers: dispatches events
- Chat runtime → Chat platforms: sends replies
- Chat runtime → Memory state: uses state
- Chat runtime → Redis state: uses state
- Chat runtime → Postgres state: uses state
- Chat runtime → ioredis state: uses state
- Bot developer → Project scaffolder: runs scaffold
- Project scaffolder → Adapter catalog: reads options
- Project scaffolder → Agent detection: detects agent
packages/create-chat-sdk/src/cli/program.ts - Project scaffolder → Chat runtime: generates bot config
- Chat runtime → AI tools and streaming: provides AI APIs
- Chat runtime → History and prompts: provides history
- Chat runtime → Workflow approvals: provides approvals
- Discord cards → Discord formatting: formats cards
- Workspace events → Google Chat users: resolves users
- Teams API client → Chat platforms: calls Teams API
- Twilio content → Chat platforms: calls Twilio API