chat-sdk

Build multi-platform chat bots with the Chat SDK TypeScript package.

Updated Dec 17, 2022
One-click install
npx skills add https://github.com/Foodshareclub/foodshare-web --skill chat-sdk-foodshareclub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: chat-sdk
Source: https://github.com/Foodshareclub/foodshare-web/tree/main/.agents/skills/chat-sdk
Command: npx skills add https://github.com/Foodshareclub/foodshare-web --skill chat-sdk-foodshareclub

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires chat.

What problem does it solve? Building bots for Slack, Teams, Discord, Telegram, and other chat platforms normally requires learning each platform's API and event model separately. This Skill provides unified guidance for the Chat SDK (chat npm package) so you write bot logic once and deploy it across many platforms. ## Core Features & Use Cases - Multi-Platform Bot Development: Handle mentions, direct messages, thread subscriptions, reactions, slash commands, cards, modals, and files across Slack, Microsoft Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp. - Project Scaffolding: Use create-chat-sdk to generate a working Next.js bot project without interactive prompts. - Adapter Discovery: Query the zero-dependency chat/adapters catalog for adapter slugs, npm packages, and required environment variables before installing anything. - Use Case: A developer wants a Slack bot that streams AI responses to mentions. The Skill points them to the shipped guides in node_modules/chat/resources/guides/ covering AI SDK integration, approval cards, and deployment. ## Quick Start Scaffold a new chat bot project by running create-chat-sdk, then ask the assistant to build a Slack bot that responds to mentions using the Chat SDK guides.

Frequently Asked Questions about chat-sdk

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a Slack bot with Chat SDK?

Scaffold a project with create-chat-sdk, configure a Slack adapter with your app credentials, and handle mention and message events in a webhook route. The shipped guides in node_modules/chat/resources/guides/ walk through Next.js setup, event handling, and deployment.

How to scaffold a chat bot project without prompts?

Run npx create-chat-sdk to generate a basic Next.js bot project non-interactively. Use npx create-chat-sdk --help to see the available CLI options and flags.

Which chat platforms does Chat SDK support?

Chat SDK supports Slack, Microsoft Teams, Google Chat, Discord, Telegram, GitHub, Linear, and WhatsApp through official, vendor-official, and community adapters. The current adapter list is maintained in the llms.txt file at chat-sdk.dev.

Can I stream AI responses to chat platforms with Chat SDK?

Yes, Chat SDK supports streamed AI responses, and the shipped guides demonstrate integration with the AI SDK's ToolLoopAgent for tool calling and streaming replies to mentions in Slack and Liveblocks threads.

How do I find required environment variables for a Chat SDK adapter?

Import listEnvVars and getSecretEnvVars from the zero-dependency chat/adapters subpath. These functions return required, optional, and credential-mode environment variables for any adapter slug without installing the adapter package.

What if node_modules/chat/docs does not exist in my project?

That path missing means the chat package is not installed yet. Install it with npm i chat, after which the docs, resources, and templates become available locally, or browse them at chat-sdk.dev/docs.