菜单
Vercel Chat SDK expert guidance. Use when building multi-platform chat bots — Slack, Telegram, Microsoft Teams, Discord, Google Chat, GitHub, Linear — with a single codebase. Covers the Chat class, adapters, threads, messages, cards, modals, streaming, state management, and webhook setup.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
基于 SOC 职业分类
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/vercel/vercel-plugin --skill chat-sdk命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
Access and test Vercel deployments protected by Vercel Authentication, SSO, or Deployment Protection. Use when curl, agent-browser, Playwright, or another automated request reaches a Vercel login or protection page; when a protected preview or production URL returns 401 or 403; when TRUSTED_SOURCES_ENVIRONMENT_MISMATCH appears; or when choosing between `vercel curl` and the `x-vercel-trusted-oidc-idp-token` header.
Vercel AI Gateway expert guidance. Use when configuring model routing, provider failover, cost tracking, or managing multiple AI providers through a unified API.
Project bootstrapping orchestrator for repos that depend on Vercel-linked resources (databases, auth, and managed integrations). Use when setting up or repairing a repository so linking, environment provisioning, env pulls, and first-run db/dev commands happen in the correct safe order.
| name | chat-sdk |
| description | Vercel Chat SDK expert guidance. Use when building multi-platform chat bots — Slack, Telegram, Microsoft Teams, Discord, Google Chat, GitHub, Linear — with a single codebase. Covers the Chat class, adapters, threads, messages, cards, modals, streaming, state management, and webhook setup. |
| metadata | {"priority":8,"docs":["https://sdk.vercel.ai/docs/ai-sdk-ui/chatbot","https://github.com/vercel/ai-chatbot"],"sitemap":"https://sdk.vercel.ai/sitemap.xml","pathPatterns":["app/api/chat/**","app/api/chat-bot/**","app/api/bot/**","app/api/slack/**","app/api/teams/**","app/api/discord/**","app/api/gchat/**","app/api/telegram/**","app/api/github-bot/**","app/api/linear-bot/**","app/api/webhooks/slack/**","app/api/webhooks/teams/**","app/api/webhooks/discord/**","app/api/webhooks/gchat/**","app/api/webhooks/telegram/**","app/api/webhooks/github/**","app/api/webhooks/linear/**","src/app/api/chat/**","src/app/api/chat-bot/**","src/app/api/bot/**","src/app/api/slack/**","src/app/api/teams/**","src/app/api/discord/**","src/app/api/gchat/**","src/app/api/telegram/**","lib/bot.*","lib/bot/**","src/lib/bot.*","src/lib/bot/**","lib/chat-bot/**","src/lib/chat-bot/**","bot/**","pages/api/bot.*","pages/api/bot/**","src/pages/api/bot.*","src/pages/api/bot/**","tests/**/bot*","test/**/bot*","fixtures/replay/**","apps/*/app/api/bot/**","apps/*/app/api/slack/**","apps/*/app/api/teams/**","apps/*/app/api/discord/**","apps/*/lib/bot/**","apps/*/src/lib/bot/**"],"importPatterns":["chat","@chat-adapter/*"],"bashPatterns":["\\bnpm\\s+(install|i|add)\\s+[^\\n]*\\bchat\\b","\\bpnpm\\s+(install|i|add)\\s+[^\\n]*\\bchat\\b","\\bbun\\s+(install|i|add)\\s+[^\\n]*\\bchat\\b","\\byarn\\s+add\\s+[^\\n]*\\bchat\\b","\\bnpm\\s+(install|i|add)\\s+[^\\n]*@chat-adapter/","\\bpnpm\\s+(install|i|add)\\s+[^\\n]*@chat-adapter/","\\bbun\\s+(install|i|add)\\s+[^\\n]*@chat-adapter/","\\byarn\\s+add\\s+[^\\n]*@chat-adapter/","\\bnpm\\s+(install|i|add)\\s+[^\\n]*@chat-adapter/telegram","\\bpnpm\\s+(install|i|add)\\s+[^\\n]*@chat-adapter/telegram","\\bbun\\s+(install|i|add)\\s+[^\\n]*@chat-adapter/telegram","\\byarn\\s+add\\s+[^\\n]*@chat-adapter/telegram"],"promptSignals":{"phrases":["chat sdk","chat bot","chatbot","conversational interface","slack bot","telegram bot","discord bot","teams bot"],"allOf":[["bot","platform"],["bot","multi"]],"anyOf":["onNewMention","onSubscribedMessage","chat adapter","cross-platform bot"],"noneOf":["useChat"],"minScore":6}} |
| retrieval | {"aliases":["chat ui","chatbot","conversation interface","messaging component"],"intents":["build chatbot","add chat interface","create messaging ui","implement chat feature"],"entities":["useChat","Message","ChatUI","StreamingMessage","chat-sdk"],"examples":["build a chatbot interface","add chat to my app","create a messaging component"]} |
| chainTo | [{"pattern":"from\\s+['\"\"]openai['\"\"]","targetSkill":"ai-sdk","message":"Direct OpenAI SDK import in chat bot — loading AI SDK guidance for unified provider abstraction and streaming."},{"pattern":"from\\s+['\\\"](slack-bolt|@slack/bolt|@slack/web-api)['\"]|require\\s*\\(\\s*['\\\"](slack-bolt|@slack/bolt|@slack/web-api)['\"]|new\\s+App\\s*\\(\\s*\\{\\s*token","targetSkill":"chat-sdk","message":"@slack/bolt or @slack/web-api detected — use the Chat SDK with @chat-adapter/slack instead for a unified multi-platform bot that works across Slack, Teams, Discord, Telegram, and more."},{"pattern":"from\\s+['\\\"](discord\\.js|discord-api-types|telegram-bot-api|telegraf|grammy)['\"]|require\\s*\\(\\s*['\\\"](discord\\.js|telegraf|grammy)['\"]","targetSkill":"chat-sdk","message":"Platform-specific bot library detected — use the Chat SDK with the corresponding @chat-adapter/* package for a unified multi-platform bot codebase."},{"pattern":"setTimeout\\s*\\(|setInterval\\s*\\(|while\\s*\\(\\s*true","targetSkill":"workflow","message":"Long-running or polling logic in chat bot — loading Workflow SDK for durable execution that survives deploys.","skipIfFileContains":"use workflow|from\\s+['\"]workflow['\"]"},{"pattern":"process\\.env\\.(OPENAI_API_KEY|ANTHROPIC_API_KEY)|from\\s+['\"]@ai-sdk/(anthropic|openai)['\"\"]","targetSkill":"ai-gateway","message":"Direct provider API key in chat bot — loading AI Gateway guidance for OIDC auth and model routing.","skipIfFileContains":"gateway\\(|@ai-sdk/gateway"}] |
Unified TypeScript SDK for building chat bots across Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp. Write bot logic once, deploy everywhere.
When Chat SDK is installed in a user project, inspect the published files that ship in node_modules:
node_modules/chat/docs/ # bundled docs
node_modules/chat/dist/index.d.ts # core API types
node_modules/chat/dist/jsx-runtime.d.ts # JSX runtime types
node_modules/chat/docs/contributing/ # adapter-authoring docs
node_modules/chat/docs/guides/ # framework/platform guides
If one of the paths below does not exist, that package is not installed in the project yet.
Read these before writing code:
node_modules/chat/docs/getting-started.mdx — install and setupnode_modules/chat/docs/usage.mdx — Chat config and lifecyclenode_modules/chat/docs/handling-events.mdx — event routing and handlersnode_modules/chat/docs/threads-messages-channels.mdx — thread/channel/message modelnode_modules/chat/docs/posting-messages.mdx — post, edit, delete, schedulenode_modules/chat/docs/streaming.mdx — AI SDK integration and streaming semanticsnode_modules/chat/docs/cards.mdx — JSX cardsnode_modules/chat/docs/actions.mdx — button/select interactionsnode_modules/chat/docs/modals.mdx — modal submit/close flowsnode_modules/chat/docs/slash-commands.mdx — slash command routingnode_modules/chat/docs/direct-messages.mdx — DM behavior and openDM()node_modules/chat/docs/files.mdx — attachments/uploadsnode_modules/chat/docs/state.mdx — persistence, locking, dedupenode_modules/chat/docs/adapters.mdx — cross-platform feature matrixnode_modules/chat/docs/api/chat.mdx — exact Chat APInode_modules/chat/docs/api/thread.mdx — exact Thread APInode_modules/chat/docs/api/message.mdx — exact Message APInode_modules/chat/docs/api/modals.mdx — modal element and event detailsFor the specific adapter or state package you are using, inspect that installed package's dist/index.d.ts export surface in node_modules.
import { Chat } from "chat";
import { createSlackAdapter } from "@chat-adapter/slack";
import { createRedisState } from "@chat-adapter/state-redis";
const bot = new Chat({
userName: "mybot",
adapters: {
slack: createSlackAdapter(),
},
state: createRedisState(),
dedupeTtlMs: 600_000,
});
bot.onNewMention(async (thread) => {
await thread.subscribe();
await thread.post("Hello! I'm listening to this thread.");
});
bot.onSubscribedMessage(async (thread, message) => {
await thread.post(`You said: ${message.text}`);
});
post(), stream(), subscribe(), setState(), startTyping()text, formatted, attachments, author info, and platform raw| Handler | Trigger |
|---|---|
onNewMention | Bot @-mentioned in an unsubscribed thread |
onDirectMessage | New DM in an unsubscribed DM thread |
onSubscribedMessage | Any message in a subscribed thread |
onNewMessage(regex) | Regex match in an unsubscribed thread |
onReaction(emojis?) | Emoji added or removed |
onAction(actionIds?) | Button clicks and select/radio interactions |
onModalSubmit(callbackId?) | Modal form submitted |
onModalClose(callbackId?) | Modal dismissed/cancelled |
onSlashCommand(commands?) | Slash command invocation |
onAssistantThreadStarted | Slack assistant thread opened |
onAssistantContextChanged | Slack assistant context changed |
onAppHomeOpened | Slack App Home opened |
onMemberJoinedChannel | Slack member joined channel event |
Read node_modules/chat/docs/handling-events.mdx, node_modules/chat/docs/actions.mdx, node_modules/chat/docs/modals.mdx, and node_modules/chat/docs/slash-commands.mdx before wiring handlers. onDirectMessage behavior is documented in node_modules/chat/docs/direct-messages.mdx.
Pass any AsyncIterable<string> to thread.post() or thread.stream(). For AI SDK, prefer result.fullStream over result.textStream when available so step boundaries are preserved.
import { ToolLoopAgent } from "ai";
const agent = new ToolLoopAgent({ model: "anthropic/claude-4.5-sonnet" });
bot.onNewMention(async (thread, message) => {
const result = await agent.stream({ prompt: message.text });
await thread.post(result.fullStream);
});
Key details:
streamingUpdateIntervalMs controls post+edit fallback cadencefallbackStreamingPlaceholderText defaults to "..."; set null to disableStreamChunk support is Slack-only; other adapters ignore non-text chunksSet jsxImportSource: "chat" in tsconfig.json.
Card components:
Card, CardText, Section, Fields, Field, Button, CardLink, LinkButton, Actions, Select, SelectOption, RadioSelect, Table, Image, DividerModal components:
Modal, TextInput, Select, SelectOption, RadioSelectawait thread.post(
<Card title="Order #1234">
<CardText>Your order has been received.</CardText>
<Actions>
<Button id="approve" style="primary">Approve</Button>
<Button id="reject" style="danger">Reject</Button>
</Actions>
</Card>
);
| Platform | Package | Factory |
|---|---|---|
| Slack | @chat-adapter/slack | createSlackAdapter |
| Microsoft Teams | @chat-adapter/teams | createTeamsAdapter |
| Google Chat | @chat-adapter/gchat | createGoogleChatAdapter |
| Discord | @chat-adapter/discord | createDiscordAdapter |
| GitHub | @chat-adapter/github | createGitHubAdapter |
| Linear | @chat-adapter/linear | createLinearAdapter |
| Telegram | @chat-adapter/telegram | createTelegramAdapter |
| WhatsApp Business Cloud | @chat-adapter/whatsapp | createWhatsAppAdapter |
| State backend | Package | Factory |
|---|---|---|
| Redis | @chat-adapter/state-redis | createRedisState |
| ioredis | @chat-adapter/state-ioredis | createIoRedisState |
| PostgreSQL | @chat-adapter/state-pg | createPostgresState |
| Memory | @chat-adapter/state-memory | createMemoryState |
chat-state-cloudflare-do@beeper/chat-adapter-matrixchat-adapter-imessage@bitbasti/chat-adapter-webex@resend/chat-sdk-adapterchat-adapter-baileysRead these published docs first:
node_modules/chat/docs/contributing/building.mdxnode_modules/chat/docs/contributing/testing.mdxnode_modules/chat/docs/contributing/publishing.mdxAlso inspect:
node_modules/chat/dist/index.d.ts — Adapter and related interfacesnode_modules/@chat-adapter/shared/dist/index.d.ts — shared errors and utilitiesdist/index.d.ts files — reference implementations for config and APIsA custom adapter needs request verification, webhook parsing, message/thread/channel operations, ID encoding/decoding, and a format converter. Use BaseFormatConverter from chat and shared utilities from @chat-adapter/shared.
Each registered adapter exposes bot.webhooks.<name>. Wire those directly to your HTTP framework routes. See node_modules/chat/docs/guides/slack-nextjs.mdx and node_modules/chat/docs/guides/discord-nuxt.mdx for framework-specific route patterns.