mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Alem Tuzlak
5ecdee36b8
Adds a durable persistence layer for @copilotkit/bot, replacing the
in-memory-only ActionStore with a pluggable StateStore.
- StateStore interface (kv/list/lock/dedup/queue) with a shared
conformance suite; MemoryStore default plus @copilotkit/bot-store-redis
and @copilotkit/bot-store-postgres backends.
- createBot({ store }): typed per-thread state via Standard Schema,
action snapshots persisted through the store, per-conversation turn
lock (onLockConflict drop|force), and inbound-event dedup keyed on a
stable eventId. ActionStore is kept as a deprecated alias.
- Cross-platform transcripts (bot.transcripts + identity resolver) with
age-bounded retention (prune on append + filter on read), and
runAgent({ transcript: true }) to auto-inject history and capture the
reply.
- createBot({ components }) re-registers components so durable actions
re-fire after a restart; restart-durability demo in examples/slack.
- Dedup is marked seen only after the turn lock is acquired, so a turn
dropped on lock-conflict does not burn its eventId (no lost retries).
- Release lockstep: bot-store-redis/postgres version with bot + bot-ui.
84 lines
4.7 KiB
Bash
84 lines
4.7 KiB
Bash
# Set SLACK_*, DISCORD_*, and/or TELEGRAM_BOT_TOKEN — the bot starts an adapter
|
|
# for each platform whose secrets are present (any one, or several at once).
|
|
|
|
# ── Slack credentials (from api.slack.com/apps → your app) ──────────────
|
|
# Set both to run on Slack; leave blank to skip Slack.
|
|
# Bot Token: OAuth & Permissions page, "Bot User OAuth Token" (xoxb-...)
|
|
SLACK_BOT_TOKEN=xoxb-...
|
|
# App-Level Token: Basic Information → App-Level Tokens → generate with the
|
|
# "connections:write" scope (xapp-...)
|
|
SLACK_APP_TOKEN=xapp-...
|
|
|
|
# ── Discord credentials (from discord.com/developers/applications → your app) ──
|
|
# Set both to run on Discord; leave blank to skip Discord. Bot page → "Reset
|
|
# Token"; under "Privileged Gateway Intents" enable BOTH Message Content and
|
|
# Server Members (both required). Application ID is on General Information.
|
|
# DISCORD_BOT_TOKEN=
|
|
# DISCORD_APP_ID=
|
|
# Optional: a guild (server) id registers slash commands instantly during dev
|
|
# (global commands can take up to ~1h). Omit in production.
|
|
# DISCORD_GUILD_ID=
|
|
|
|
# ── Telegram credentials (from @BotFather on Telegram) ──────────────────
|
|
# Set to run on Telegram; leave blank to skip Telegram. Message @BotFather →
|
|
# /newbot → copy the token it gives you. Long-polling is the default ingress
|
|
# (no public URL or webhook setup needed).
|
|
# TELEGRAM_BOT_TOKEN=
|
|
|
|
# ── Persistence (optional) ──────────────────────────────────────────────
|
|
# Optional Redis-backed durable store. Used by `pnpm demo:restart` (and any
|
|
# bot that passes `store: { adapter: createRedisStore({ url }) }`). Leave blank
|
|
# for the in-memory default. With it set, interactive actions (e.g. an approval
|
|
# card's button) survive a bot restart — see `app/demo-restart.tsx`.
|
|
# Start a local one with `docker compose up -d`.
|
|
# REDIS_URL=redis://localhost:6379
|
|
|
|
# ── Agent backend (runtime.ts) ──────────────────────────────────────────
|
|
# The AG-UI endpoint the bridge POSTs to. Default points at the local
|
|
# CopilotKit runtime started by `pnpm runtime`.
|
|
AGENT_URL=http://localhost:8200/api/copilotkit/agent/triage/run
|
|
# Optional auth header forwarded to the agent (for a deployed runtime).
|
|
# AGENT_AUTH_HEADER=Bearer ...
|
|
|
|
# Model for the BuiltInAgent. provider/model — the runtime resolves the
|
|
# provider and reads the matching API key below. Defaults to openai/gpt-5.5.
|
|
# AGENT_MODEL=anthropic/claude-sonnet-4.5
|
|
OPENAI_API_KEY=sk-...
|
|
# ANTHROPIC_API_KEY=sk-ant-...
|
|
# GOOGLE_API_KEY=...
|
|
|
|
# ── Linear MCP ──────────────────────────────────────────────────────────
|
|
# The hosted Linear MCP accepts a raw API key as a bearer token (no OAuth
|
|
# dance). Create one at linear.app → Settings → API → Personal API keys.
|
|
# Leave LINEAR_API_KEY blank to run without Linear.
|
|
LINEAR_API_KEY=lin_api_...
|
|
# Override only if you front the MCP yourself; default is the hosted server.
|
|
# LINEAR_MCP_URL=https://mcp.linear.app/mcp
|
|
# Default Linear team the bot files/queries against.
|
|
LINEAR_TEAM_KEY=CPK
|
|
|
|
# ── Notion MCP ──────────────────────────────────────────────────────────
|
|
# Run the official Notion MCP as a Streamable-HTTP sidecar: `pnpm notion-mcp`.
|
|
# NOTION_TOKEN is the Notion integration secret the sidecar uses to call the
|
|
# Notion API (notion.so → Settings → Connections → develop integrations).
|
|
# NOTION_MCP_AUTH_TOKEN is the bearer the sidecar requires on its HTTP
|
|
# transport; the agent sends it. Pick any strong string and use it in both
|
|
# `pnpm notion-mcp` and here. Leave NOTION_MCP_AUTH_TOKEN blank to run
|
|
# without Notion.
|
|
NOTION_TOKEN=ntn_...
|
|
NOTION_MCP_AUTH_TOKEN=choose-a-strong-shared-secret
|
|
# Override only if the sidecar runs elsewhere; default is the local sidecar.
|
|
# NOTION_MCP_URL=http://127.0.0.1:3001/mcp
|
|
|
|
# ── WhatsApp Cloud API (optional — omit to run Slack-only) ──────────────
|
|
# From your Meta App → WhatsApp → API Setup. Leave WHATSAPP_ACCESS_TOKEN blank
|
|
# to disable the WhatsApp adapter entirely. Use a System User token in prod
|
|
# (the temporary token expires in 24h).
|
|
WHATSAPP_ACCESS_TOKEN=
|
|
WHATSAPP_PHONE_NUMBER_ID=
|
|
WHATSAPP_APP_SECRET=
|
|
WHATSAPP_VERIFY_TOKEN=choose-any-string-and-paste-it-in-the-webhook-config
|
|
# Webhook path (default /webhook). The server listens on $PORT — Railway injects
|
|
# it and routes the service's public domain there; locally it defaults to 3000.
|
|
# WHATSAPP_PATH=/webhook
|