# Chat SDK

A unified TypeScript SDK for building chat bots and agents across Slack, Microsoft Teams, Google Chat, Discord, Telegram, WhatsApp, and more — with type-safe handlers, JSX cards, and AI streaming.

This file helps AI agents understand and use this documentation site.

## Documentation Surfaces

- [Docs](https://chat-sdk.dev/docs): Documentation section: docs
- [Adapters](https://chat-sdk.dev/adapters): Documentation section: adapters
- [Full documentation context](https://chat-sdk.dev/llms.txt): All configured documentation as Markdown
- [Semantic documentation sitemap](https://chat-sdk.dev/sitemap.md): High-level documentation map for agent navigation
- Page-level Markdown: append .md or .mdx to a documentation URL

## When to use Chat SDK

- Category: Chat bot SDK
- Audience: developers building chat bots and agents, Vercel users
Common use cases:

- Build a bot once and run it on every major chat platform
- Send rich interactive cards with JSX
- Stream AI responses into chat threads in real time

## Important Links

- [Docs](https://chat-sdk.dev/docs)
- [Adapters](https://chat-sdk.dev/adapters)
- [Resources](https://chat-sdk.dev/resources)
- [API](https://chat-sdk.dev/docs/api)
- [GitHub](https://github.com/vercel/chat/)
- [Chat SDK source](https://github.com/vercel/chat): Source repository for Chat SDK and its adapters
- [Chat SDK agent skill](https://chat-sdk.dev/AGENTS.md): Agent skill with instructions for building Chat SDK bots
- [GitHub repository](https://github.com/vercel/chat): Source repository

## Agent Instructions

- See /adapters for the catalog of official, vendor-official, and community platform and state adapters; each adapter page is available as Markdown with a .md extension.
- Use /sitemap.md to identify the most relevant documentation pages before answering broad questions.
- Use /llms.txt for an index of every documentation page, or /llms-full.txt for the complete documentation corpus as Markdown context.
- Fetch individual documentation pages with a .md or .mdx extension for focused page-level context.
- Do not assume API, authentication, OpenAPI, or MCP support unless it is listed in this file.