mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Benjamin Taylor
6f58b2c6a4
Three names for one value were live in CopilotKit's own documentation, and following the wrong one with a CLI-provisioned project yields an undefined key: - `INTELLIGENCE_API_KEY` — what `copilotkit project select` writes, used by all 34 integration examples and the docs site. - `COPILOTKIT_INTELLIGENCE_API_KEY` — the seven Channels package READMEs and the packaged skills. Nothing ever read it. - `COPILOTKIT_API_KEY` — the Slack and Teams examples, and the TSDoc on `CopilotKitIntelligence` itself, which is what an IDE shows on hover. `INTELLIGENCE_API_KEY` wins, because it is the name the CLI provisions and changing it would break every scaffolded project in the wild. `COPILOTKIT_INTELLIGENCE_API_KEY` is retired outright — no code read it. `COPILOTKIT_API_KEY` stays readable as a deprecated alias in the two examples that consume it, so an existing `.env` keeps working, and is documented as deprecated everywhere it appears. The skills reference also documented `organizationId`, sourced from a fourth and fifth env name, as a `CopilotKitIntelligence` option. It is not one: `CopilotKitIntelligenceConfig` has no such field, so the copy-pasteable sample it appeared in would not compile. Removed from the samples, and the prose that told readers to fetch a value for it corrected. The Intelligence wiring itself was published only inside `node_modules/@copilotkit/runtime/skills/`, and the only docs pages showing `CopilotKitIntelligence` were the two Channels frontends — so a developer on the plain web path had no page to reach it from. Adds `/premium/connect-your-runtime`, which covers the wiring, how to confirm the credential is actually consumed, and the self-hosted two-URL rule. `scripts/validate-intelligence-env-names.ts` keeps this from drifting back. It runs unfiltered in CI on purpose: the two workflows that would otherwise cover it filter paths, and static/quality ignores `examples/**` — exactly where the deprecated alias lives.
107 lines
6.2 KiB
Bash
107 lines
6.2 KiB
Bash
# Set SLACK_*, DISCORD_*, TELEGRAM_BOT_TOKEN, and/or WHATSAPP_* — 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=
|
|
|
|
# ── 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 agent. This runtime is OpenAI-only (its web search is an OpenAI
|
|
# hosted provider tool), so AGENT_MODEL must be an OpenAI model id — either bare
|
|
# ("gpt-5.5-mini") or "openai/<id>" (the "openai/" prefix is stripped). Defaults
|
|
# to openai/gpt-5.5. OPENAI_API_KEY is required.
|
|
# AGENT_MODEL=openai/gpt-5.5-mini
|
|
OPENAI_API_KEY=sk-...
|
|
|
|
# ── Intelligence (REQUIRED — owns the Channel lifecycle) ────────────────
|
|
# A Channel runs ONLY through the Intelligence runtime, so BOTH the native path
|
|
# (`pnpm dev` / `pnpm start`, app/index.ts) AND the zero-adapter managed variant
|
|
# (`pnpm channel`, app/managed.ts) need these. Free tier is enough. The direct
|
|
# platform adapters keep their own Slack/Discord/… credentials above; the
|
|
# runtime that owns the Channel is configured with the Intelligence key and
|
|
# starts those adapters for you (there is no launcher, and no infra ids to
|
|
# supply — the runtime derives project/adapter/channel from the config below
|
|
# plus the channel name chosen in code).
|
|
# Project runtime API key (cpk-…). The only Intelligence value you need: the SDK
|
|
# defaults both URLs to the managed platform.
|
|
# `COPILOTKIT_API_KEY` is a deprecated alias for this variable, still read as a fallback.
|
|
INTELLIGENCE_API_KEY=cpk-...
|
|
# Optional, for a self-hosted or dev Intelligence deployment only. Set BOTH or
|
|
# neither: the realtime plane is a DIFFERENT host from the API (api.… vs
|
|
# realtime.…), so it cannot be derived from the API URL, and setting one alone
|
|
# leaves the other plane on the managed platform.
|
|
# COPILOTKIT_INTELLIGENCE_URL=https://api.intelligence.copilotkit.ai
|
|
# COPILOTKIT_INTELLIGENCE_WS_URL=wss://realtime.intelligence.copilotkit.ai
|
|
# Optional: port for the Intelligence runtime that owns the Channel lifecycle
|
|
# (loopback-only; keeps the process alive; distinct from WhatsApp's $PORT
|
|
# webhook). Defaults to 8300.
|
|
# CHANNELS_PORT=8300
|
|
|
|
# ── 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 — a non-blank value turns the
|
|
# Linear MCP ON, so keep it empty unless you have a real key.
|
|
LINEAR_API_KEY=
|
|
# 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.
|
|
# Both are blank by default — a non-blank NOTION_MCP_AUTH_TOKEN turns the Notion
|
|
# MCP ON. NOTION_TOKEN is only needed when you actually run `pnpm notion-mcp`.
|
|
NOTION_TOKEN=
|
|
NOTION_MCP_AUTH_TOKEN=
|
|
# Port the `pnpm notion-mcp` sidecar listens on (default 3001). If you change
|
|
# it, update the port in NOTION_MCP_URL below to match.
|
|
# NOTION_MCP_PORT=3001
|
|
# 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
|