Skip to content
Back to search

chat

Universal chat layer for building bots and agents.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/vercel/chat with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/vercel/chat'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/vercel-chat/badge.svg)](/listings/vercel-chat)

HTML

<a href="/listings/vercel-chat"><img src="/api/listings/vercel-chat/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm i chat

Install one or more adapters for your platforms:

npm install @chat-adapter/slack @chat-adapter/teams @chat-adapter/gchat

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 135 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Chat SDK
  2. [![Agent Stack](https://img.shields.io/badge/Agent%20Stack-000?style=flat-square&logo=vercel&logoColor=FFF&labelColor=000&color=000)](https://vercel.com/kb/agent-stack)
  3. [![MIT License](https://img.shields.io/badge/License-MIT-000?style=flat-square&logo=opensourceinitiative&logoColor=white&labelColor=000&color=000)](LICENSE)
  4. Unified TypeScript SDK for building chat bots across Slack, Microsoft Teams, Google Chat, Discord, Telegram, GitHub, Linear, WhatsApp, and more. **Write your bot logic once, deploy everywhere.**
  5. ## Installation
  6. ```bash
  7. npm i chat
  8. ```
  9. Install one or more adapters for your platforms:
  10. ```bash
  11. npm install @chat-adapter/slack @chat-adapter/teams @chat-adapter/gchat
  12. ```
  13. ## CLI
  14. Scaffold a minimal Next.js bot app with `create-chat-sdk`:
  15. ```bash
  16. npx create-chat-sdk@latest my-bot
  17. ```
  18. The CLI generates your `Chat` configuration, webhook route, `.env.example` file, dependencies, and optional Web adapter route from the [adapter catalog](#adapter-catalog). See the [CLI docs](https://chat-sdk.dev/docs/create-chat-sdk) for options and non-interactive usage.
  19. ## Usage
  20. ```typescript
  21. import { Chat } from "chat";
  22. import { createSlackAdapter } from "@chat-adapter/slack";
  23. import { createRedisState } from "@chat-adapter/state-redis";
  24. const bot = new Chat({
  25. userName: "mybot",
  26. adapters: {
  27. slack: createSlackAdapter(),
  28. },
  29. state: createRedisState(),
  30. });
  31. bot.onNewMention(async (thread) => {
  32. await thread.subscribe();
  33. await thread.post("Hello! I'm listening to this thread.");
  34. });
  35. bot.onSubscribedMessage(async (thread, message) => {
  36. await thread.post(`You said: ${message.text}`);
  37. });
  38. ```
  39. See the [Getting Started guide](https://chat-sdk.dev/docs/getting-started) for a full walkthrough.
  40. ## Adapters
  41. Browse official, vendor-official, and community adapters on [chat-sdk.dev/adapters](https://chat-sdk.dev/adapters). Learn how to [build your own adapter](https://chat-sdk.dev/docs/contributing/building).
  42. ## Adapter catalog
  43. [`@chat-adapter/catalog`](packages/catalog) lists every adapter on chat-sdk.dev with its npm package, maintainer, and supported capabilities. Official and vendor-official entries also include the factory export, peer dependencies, and environment variables needed to set them up. It has no dependencies and imports no adapter code, so you can use it in websites, setup screens, build scripts, and CLIs. chat-sdk.dev and `create-chat-sdk` both read from it.
  44. ```bash
  45. npm i @chat-adapter/catalog
  46. ```
  47. ```typescript
  48. import {
  49. getFeatureSupport,
  50. getSecretEnvVars,
  51. listAdapters,
  52. } from "@chat-adapter/catalog";
  53. const streamingAdapters = listAdapters({ type: "platform" }).filter(
  54. (adapter) => getFeatureSupport(adapter, "streaming").status === "yes"
  55. );
  56. const slackSecrets = getSecretEnvVars("slack").map((envVar) => envVar.key);
  57. ```
  58. See the [Adapter Catalog docs](https://chat-sdk.dev/docs/adapter-catalog) for the full API.
  59. ## Features
  60. - [**Event handlers**](https://chat-sdk.dev/docs/usage) — mentions, messages, reactions, button clicks, slash commands, modals
  61. - [**AI streaming**](https://chat-sdk.dev/docs/streaming) — stream LLM responses with native Slack streaming, Telegram private chat draft previews, and post+edit fallback
  62. - [**Cards**](https://chat-sdk.dev/docs/cards) — JSX-based interactive cards (Block Kit, Adaptive Cards, Google Chat Cards)
  63. - [**Actions**](https://chat-sdk.dev/docs/actions) — handle button clicks and dropdown selections
  64. - [**Modals**](https://chat-sdk.dev/docs/modals) — form dialogs with text inputs, dropdowns, and validation
  65. - [**Slash commands**](https://chat-sdk.dev/docs/slash-commands) — handle `/command` invocations
  66. - [**Emoji**](https://chat-sdk.dev/docs/emoji) — type-safe, cross-platform emoji with custom emoji support
  67. - [**File uploads**](https://chat-sdk.dev/docs/files) — send and receive file attachments
  68. - [**Direct messages**](https://chat-sdk.dev/docs/direct-messages) — initiate DMs programmatically
  69. - [**Ephemeral messages**](https://chat-sdk.dev/docs/ephemeral-messages) — user-only visible messages with DM fallback
  70. - [**Overlapping messages**](https://chat-sdk.dev/docs/concurrency) - burst, queue, debounce, drop, or process concurrent messages on the same thread
  71. ## AI Coding Agents
  72. If you use an AI coding agent such as OpenAI Codex, Claude Code, or Cursor, install the Chat SDK skill so it knows the SDK APIs, adapter patterns, and project conventions before writing code.
  73. ```bash
  74. npx skills add vercel/chat
  75. ```
  76. The skill references bundled documentation in `node_modules/chat/docs`, plus adapter guides and starter templates in the published package.
  77. You can also install the [Vercel Plugin](https://vercel.com/plugin) for a broader agent toolkit. It includes the Chat SDK skill alongside specialist agents, slash commands, and more:
  78. ```bash
  79. npx plugins add vercel/vercel-plugin
  80. ```
  81. For agent-readable documentation, see [chat-sdk.dev/llms.txt](https://chat-sdk.dev/llms.txt) (page index) or [chat-sdk.dev/llms-full.txt](https://chat-sdk.dev/llms-full.txt) (full text).
  82. ## Documentation
  83. Full documentation is available at [chat-sdk.dev/docs](https://chat-sdk.dev/docs) and guides are available in the [Vercel Knowledge Base](https://vercel.com/kb/chat-sdk).
  84. ## Contributing
  85. See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for guidance on contributing to Chat SDK.
  86. ## Support
  87. For help or questions, see [SUPPORT.md](./.github/SUPPORT.md).
  88. To report a security vulnerability, see [SECURITY.md](./.github/SECURITY.md).
  89. ## License
  90. MIT
  91. [![Made by Vercel](https://img.shields.io/badge/Made%20By%20Vercel-000?style=flat-square&logo=vercel&logoColor=white&labelColor=000&color=000)](https://vercel.com)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.