Chat SDK is a TypeScript software development kit for creating chat bots that work across services such as Slack, Microsoft Teams, Google Chat, Discord, Telegram, and WhatsApp. It lets developers write bot behavior once while using adapters for different messaging platforms, with support for events, interactive cards, modals, commands, files, and streamed AI responses. The catalogue includes skills and instructions for working with the SDK.
Borrowing it
Nothing to install: this file belongs to vercel/chat. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/vercel/chat/main/AGENTS.mdgit clone --depth 1 https://github.com/vercel/chatWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/vercel/chat/agents-md)<a href="https://agentmods.dev/instructions/vercel/chat/agents-md"><img src="https://agentmods.dev/badge/instructions/vercel/chat/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/vercel/chat/agents-md"><img src="https://agentmods.dev/badge/instructions/vercel/chat/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.01376 | $0.01376 |
| Opus 5.5 | $0.00550 | $0.00550 |
| Sonnet 5.5 | $0.00275 | $0.00275 |
| Haiku 4.5 | $0.00138 | $0.00138 |
Grade A, and why
chat AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 16d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 101 lines — stays where its author put it; the contents beside it link to each section on GitHub.
AGENTS.md
Guidance for coding agents working in this repository. For PR workflow, signed commits, and changeset rules, see .github/CONTRIBUTING.md.
Commands
pnpm install
pnpm validate # knip + check + typecheck + test + build — run before declaring work done
pnpm check # lint/format (Ultracite/Biome)
pnpm fix # auto-fix lint/format issues
pnpm typecheck
pnpm test # all package tests via Turborepo (includes integration-tests)
pnpm test:workspace # single Vitest run across unit-test packages only
pnpm build
pnpm dev # watch mode
pnpm knip # unused exports/dependencies
pnpm konsistent # adapter/state package shape (see .github/konsistent.json)
# Per-package
pnpm --filter chat test
pnpm --filter @chat-adapter/slack build
pnpm --filter docs dev # preview chat-sdk.dev locally
Install dependencies with pnpm add, not by editing package.json by hand.
Monorepo layout
pnpm + Turborepo monorepo. Packages are ESM ("type": "module"), TypeScript, bundled with tsup.
| Path | Role |
|---|---|
packages/chat |
Core SDK (chat): Chat, types, mdast markdown |
packages/catalog |
@chat-adapter/catalog: static adapter catalog (listing metadata, capabilities, setup requirements) |
packages/adapter-* |
Platform adapters (slack, teams, gchat, discord, telegram, whatsapp, github, linear, web, messenger, twilio, …) |
packages/adapter-shared |
Shared adapter utilities |
packages/state-* |
State adapters (memory, redis, ioredis, pg) |
packages/create-chat-sdk |
create-chat-sdk CLI scaffold |
packages/tests |
@chat-adapter/tests — Vitest factories/matchers for adapter tests |
packages/integration-tests |
Replay + emulator tests; needs credentials for live API tests |
apps/docs |
fumadocs site (chat-sdk.dev) |
examples/* |
Example bots; package.json name must be example-* (private, no changeset) |
When editing a specific package, read its AGENTS.md if present (most adapters, state packages, create-chat-sdk, and packages/catalog have one).
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 16d ago Changed · +1 lines · +30 tokens per session c7d115c86fc4
- 25d ago Changed · +1 lines · +67 tokens per session 1210de6abdb4
- 1mo ago First seen · 99 lines · 1,279 tokens per session scan A 44dc7d5418fc
chat AGENTS.md is an instructions file published in the GitHub repository vercel/chat (2,421 stars, last pushed yesterday), licensed MIT. It adds 1,376 tokens to every session, about $0.0055 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
Other instructions, from other repositories
vscode buildNext.instructions.md
Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).
next.js AGENTS.md
AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
langchain AGENTS.md
AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
deepseek-harness AGENTS.md
AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.