packages/bot-slack/ARCHITECTURE.md
How @copilotkit/bot-slack is structured and why each boundary exists.
This package is the Slack PlatformAdapter for @copilotkit/bot.
The bot engine owns the platform-agnostic orchestration (handlers, the
run/tool/interrupt loop, JSX action binding, the ActionStore); this package
owns everything Slack-specific: Bolt ingress, Block Kit egress, streaming,
and opaque-id interactions.
chat.update throttling,
mrkdwn translation, chunking, interrupt capture, and block_actions
routing all live behind the PlatformAdapter interface.chat.update doesn't crash the run.conversations.replies / conversations.history); the conversation
store reconstructs each turn's agent.messages from Slack on the fly.PlatformAdapterSlackAdapter (constructed via slack(opts)) implements
@copilotkit/bot's PlatformAdapter. The members it implements:
platform, capabilities (supportsStreaming: true, modals/typing/
reactions false, maxBlocksPerMessage: 50), ackDeadlineMs (3000)start(sink) / stop() — bring the Bolt app up / down and push normalized
events into the engine's IngressSinkrender(ir) — IR → Block Kit (renderBlockKit)post / update / stream / delete — egress via the Slack Web clientcreateRunRenderer(target) — the AG-UI RunRenderer for a rundecodeInteraction(raw) — native block_actions payload → InteractionEventlookupUser(query) — directory search for @-mention resolution
(backs thread.lookupUser)getMessages(target) — the thread's messages via conversations.replies
(backs thread.getMessages)postFile(target, args) — upload a file via files.uploadV2
(backs thread.postFile)conversationStore — Slack-backed getOrCreate → AgentSessionThe engine drives ingress through the IngressSink it hands to start
(sink.onTurn / sink.onInteraction) and egress through these methods.
Slack event ──► attachSlackListener ──► IngressSink.onTurn(IncomingTurn)
│
▼
@copilotkit/bot: Thread
│ thread.runAgent()
▼
runAgentLoop
┌──────────────────────────────────────┴──────────────────────────────┐
│ agent.runAgent(..., RunRenderer.subscriber) │
│ • event-renderer streams TEXT_MESSAGE_* → chat.update (Block Kit) │
│ • captures frontend tool calls + on_interrupt custom events │
└──────────────────────────────────────┬──────────────────────────────┘
│
┌─────────────────────────────────┼─────────────────────────────┐
▼ (captured tool call) ▼ (captured interrupt) ▼ (done)
tool.handler(args, ctx) onInterrupt handler finish
renders JSX via thread.post posts picker via thread.post
→ renderSlackMessage/renderBlockKit → awaitChoice / thread.resume(value)
→ Block Kit posted to Slack re-enters runAgentLoop with
forwardedProps.command on resume
attachSlackListener is the translation layer between Slack's event model
and the engine's domain. It filters subtypes, bot echoes, untracked threads,
and mention duplicates, and emits a normalized turn. The adapter resolves the
sender to a PlatformUser (cached per id) and calls sink.onTurn with a
conversationKey (conversationKeyOf), replyTarget, userText, and
user.
thread.runAgent resolves the conversation's AgentSession from the
conversationStore, creates createRunRenderer(target), and runs
runAgentLoop. The renderer (event-renderer.ts) subscribes to AG-UI
events: it lazily creates a stream on the first TEXT_MESSAGE_CONTENT,
accumulates deltas, optionally surfaces :wrench: / :white_check_mark:
tool-status rows (showToolStatus), and captures frontend tool calls and
on_interrupt custom events for the loop to read after each runAgent.
When the agent calls a registered frontend tool, the loop validates the args
(Standard Schema) and invokes tool.handler(args, ctx). ctx is the single
shared BotToolContext ({ thread, message?, user?, signal?, platform }) —
there is no Slack-specific context. Slack power is reached only through
capability-gated thread methods the adapter backs (getMessages,
lookupUser, postFile). A render-tool handler renders JSX with
thread.post(<Card .../>), which goes through the engine's action-binding
then renderSlackMessage / renderBlockKit → Block Kit.
thread.awaitChoice(<Picker .../>) posts a picker and blocks the engine's
waiter until a click in that conversation resolves it. A captured agent
interrupt is dispatched to the registered onInterrupt handler, which posts a
picker whose button onClick calls thread.resume(value); the loop
re-enters with forwardedProps.command.
app.action(/.*/) acks every click within ≤3s, then decodeInteraction
pulls the opaque minted id (ck:…), any tiny bind() value, and the message
ref out of the block_actions payload, building an InteractionEvent. The
engine resolves it: an awaiting HITL waiter, or ActionRegistry.dispatch —
a hot-cache hit, or a cold-path re-render rehydration (load the snapshot,
re-render the named component with frozen props, re-walk to the handler's
path). A miss after restart degrades to "this action expired."
These files carry over from the pre-rework package, lightly adapted:
| File | Job |
|---|---|
slack-listener.ts | Slack events → normalized turns; ingress filters. |
conversation-store.ts | Slack-backed history reconstruction; folds chunked bot replies. |
message-stream.ts | Per-message chat.update queue + ≥800ms throttle (no update races). |
chunked-message-stream.ts | Multi-message chunking; keeps fenced blocks whole; per-chunk transform. |
auto-close-streaming.ts | Closes dangling markdown brackets mid-stream (idempotent). |
markdown-to-mrkdwn.ts | GFM Markdown → Slack mrkdwn; column-aligns tables in a fence. |
download-files.ts | Inbound file download → AG-UI multimodal content parts. |
sanitizing-http-agent.ts | HTTP agent that sanitizes outbound requests to the AG-UI backend. |
src/
├── index.ts # public exports
├── adapter.ts # slack() factory + SlackAdapter (PlatformAdapter impl) + Bolt wiring
├── event-renderer.ts # createRunRenderer: AG-UI subscriber → stream + tool/interrupt capture
├── interaction.ts # decodeInteraction (opaque id) + conversationKeyOf
├── render/
│ ├── block-kit.ts # renderBlockKit / renderSlackMessage (IR → Block Kit)
│ └── budget.ts # SLACK_LIMITS + truncate/clamp degradation
├── slack-listener.ts # Slack events → IncomingTurn (filters)
├── conversation-store.ts # Slack-backed conversation reconstruction
├── chunked-message-stream.ts # multi-message chunking + mrkdwn transform
├── message-stream.ts # per-message chat.update queue + throttle
├── markdown-to-mrkdwn.ts # md → Slack mrkdwn
├── auto-close-streaming.ts # mid-stream bracket closer
├── download-files.ts # inbound file → multimodal content parts
├── sanitizing-http-agent.ts # sanitizing AG-UI HTTP agent
├── built-in-tools.ts # lookup_slack_user + defaultSlackTools (as BotTools)
├── built-in-context.ts # tagging / mrkdwn / convo-model context entries
└── types.ts # IncomingTurn, ReplyTarget, ConversationKey, DM_SCOPE
ActionStore is separately in-memory in v1, so inline
interaction handlers expire on restart — see the @copilotkit/bot README.)