Upgrading¶

What changes between releases that you might have to act on, with the code before and after. If none of a release's items apply to you, upgrading is a version bump.

The kaboo libraries can be upgraded in any order: this release reads what older agents send, and nothing it sends can be mistaken for an approval by an older agent. Features that span the stack light up once every piece is upgraded — see Upgrading the stack.

0.12.1¶

Who: no one needs to change anything.

A sent message renders in CopilotKit's own message and bubble instead of a copy of its classes, so it follows CopilotKit's styling, and fast-json-patch is no longer installed.

0.12¶

0.12 reads AG-UI's own events: sub-agents as SUBAGENT_* events, questions as tools the browser runs, approvals as native interrupts. Upgrade the three libraries together: kaboo-workflows 0.29, kaboo-runtime 0.8 and kaboo-react 0.12. It needs CopilotKit 1.79.1 or later:

- "@copilotkit/react-core": ">=1.78.0 <2"
+ "@copilotkit/react-core": ">=1.79.1 <2"

Cards come from sub-agent events¶

Who: everyone, and code that reads useActivity().

The groups are folded from SUBAGENT_* events and the events tagged with their subagentRunId, live and on replay alike. The entry agent has no group any more (inlineChatOwner is gone): its work is the chat. StreamGroup.tokens and the embedded tool on timeline entries are removed — read the timeline's text entries, and resolve tool entries with resolveTimelineTool. applyActivityPatch is removed. usageByRun and traceByRun now come from each run's RUN_FINISHED, and a group's traceId from its SUBAGENT_STARTED.

Questions and requests are tools the browser runs¶

Who: apps with questions, file or data-source requests, or a custom question card.

Register the tools; an agent calls them when its workflow's client_tools allow it:

- <KabooProvider ...>  {/* KabooAskUser answered ask_user interrupts */}
+ function BrowserTools() {
+   useAskUserTool();
+   useRequestTool({ name: "request_files", description, parameters, render: FilesPanel });
+   return null;
+ }

KabooAskUser is removed. A custom question card moves from interruptRenderers={{ form: Card }} to useAskUserTool({ render: Card }), and receives args, status, answer and skip instead of reason, onResolve and onCancel. Pre-0.27 question shapes (type: "checkbox", input_type) are no longer read. See Human-in-the-loop.

Approvals render on CopilotKit's `useInterrupt`¶

Who: apps that used the InterruptBridge.

InterruptBridgeProvider, InterruptBridgePublisher, useInterruptBridge and useInterruptFor are removed. KabooInterruptHandler draws approvals and your own interrupt kinds from CopilotKit's useInterrupt; interruptRenderers, approvalScopes and onInterruptError work as before. Continuation pauses are no longer resolved, because kaboo-workflows 0.29 no longer sends them.

`KabooProvider` passes generative UI through¶

Who: apps that set CopilotKit props through copilotKitProps.

properties, renderToolCalls, renderActivityMessages, a2ui and openGenerativeUI are props of KabooProvider now:

- <KabooProvider runtimeUrl="/api/copilotkit" agent="kaboo" copilotKitProps={{ properties }}>
+ <KabooProvider runtimeUrl="/api/copilotkit" agent="kaboo" properties={properties}>

Who: apps with a turnFooter.

The footer renders after every turn's last reply, including a turn the agent answered without delegating; its groups is empty then. runIds lists every run since the person's message.

New¶

KabooChat — the chat with kaboo's transcript and drill-down, whose composer sends through useKabooSend, so a new message skips open requests.
useAgentState, useLiveToolCalls, useAgentPresence for canvases (Concepts).
withSubagentLabel labels a sub-agent's generative UI surface (Generative UI).
Tool renderers registered with CopilotKit draw inside sub-agent cards too (Custom tool cards).
Tool labels and structured outputs from kaboo-workflows 0.29 show on sub-agents' cards.
The package's CommonJS build has its own type declarations.

0.11.3¶

Who: apps whose agent delegates to sub-agents that ask questions or need approvals.

A request a delegate waits on now shows under its card and in its drill-in view. Upgrade together with kaboo-workflows 0.28.3, which records the coordinator's own tool calls: without this release, those requests are drawn nowhere. To let people open a delegate's work, place GlassTabs and DrillDetailView beside the chat, as in Getting started.

0.11.2¶

Who: apps with approvals or questions, apps that recover from a refused answer themselves, and apps with a turnFooter.

Answers that never reach the agent (the host refuses a decision, or the request fails) now come back to be answered again, with the reason above them, instead of staying "Response submitted" until a reload. To show the reason elsewhere too, pass onInterruptError:

- <KabooProvider runtimeUrl="/api/copilotkit" agent="assistant">
+ <KabooProvider runtimeUrl="/api/copilotkit" agent="assistant" onInterruptError={(message) => toast.error(message)}>

If your app reconnected the agent itself after such a failure, remove that code. Pair this release with kaboo-runtime 0.7.1, which opens a run that fails before the agent starts with RUN_STARTED; older runtimes recover too.

useInterruptBridge() also gives failure, setFailure and clearAnswered for custom cards, and tools still running in a run that errors or stops now show as cancelled instead of spinning.

With kaboo-workflows 0.28.2, a turn resumed after an answer ends after its last reply: the turnFooter slot renders there, and its new runIds list every run of the turn. If your footer looked things up by the groups' runId, use runIds instead; the groups' runId is only the run that opened them.

0.11¶

Who: everyone. 0.11 runs on CopilotKit 1.78 or later, the AG-UI 1.0 generation.

- "@copilotkit/react-core": ">=1.62.0 <1.71.2"
+ "@copilotkit/react-core": ">=1.78.0 <2"

Upgrade @copilotkit/react-core with it, and the server's CopilotKit packages with kaboo-runtime 0.7. The components and hooks are unchanged. On CopilotKit 1.62 to 1.71.1, stay on kaboo-react 0.10.

0.10.1¶

Who: anyone on CopilotKit 1.71.2 or later.

The peer range now stops where this release is tested:

- "@copilotkit/react-core": ">=1.62.0"
+ "@copilotkit/react-core": ">=1.62.0 <1.71.2"

CopilotKit 1.71.2 and later bring in AG-UI 1.0 pieces, which the next minor release supports. Until then, stay on CopilotKit 1.71.1 or earlier.

0.10¶

The built-in question card replaces custom clarification panels¶

Who: apps that register their own form renderer to get a Cursor-style question card — kaboo and kaboo-bmo route ask_user to a ClarificationPanel.

The built-in card is now that card: the agent's options, single or multi-select, an Other row with a text field on every question, Submit and Skip. Delete the custom panel and style the built-in one with the theme tokens and class names (Theming).

- function KabooFormInterrupt(props: InterruptRendererProps) {
-   // ...file and datasource branches...
-   return (
-     <ClarificationPanel
-       questions={toClarificationQuestions(props.reason)}
-       onSubmit={(answers) => props.onResolve(answersToPayload(props.reason, answers))}
-     />
-   );
- }
- const interruptRenderers = { form: KabooFormInterrupt }
+ // No form renderer: the built-in question card handles ask_user.

There is no free-text box any more. A question from an agent before kaboo-workflows 0.27 with no options is answered through Other alone; one with type: "checkbox" is multi-select.

Custom request kinds replace `kaboo_kind`¶

Who: apps whose tools disguise a file or data source picker as a text question with a discriminator (kind, kaboo_kind) and route it from a form renderer.

Register a renderer per kind instead. The tool raises type: "files" (see the kaboo-workflows upgrade guide), and its fields arrive on reason.

- if (reason.kaboo_kind === "files") {
-   return <FilePanel context={reason.questions[0]?.question ?? ""} onSubmit={props.onResolve} />;
- }
+ interruptRenderers={{ files: FilesRenderer, datasources: DatasourcesRenderer }}

import { KabooProvider, type InterruptRendererProps } from "@pgege/kaboo-react";

interface FilesRequest {
  type: string;
  message?: string;
  accept?: string[];
}

function FilesRenderer({ reason, onResolve, onCancel }: InterruptRendererProps<FilesRequest>) {
  return (
    <div>
      <p>{reason.message}</p>
      <input
        type="file"
        accept={reason.accept?.join(",")}
        onChange={(e) => onResolve({ files: [...(e.target.files ?? [])].map((f) => f.name) })}
      />
      <button onClick={onCancel}>Skip</button>
    </div>
  );
}

export function Chat({ threadId }: { threadId: string }) {
  return (
    <KabooProvider
      runtimeUrl="/api/copilotkit"
      agent="kaboo"
      threadId={threadId}
      interruptRenderers={{ files: FilesRenderer }}
    >
      <div />
    </KabooProvider>
  );
}

A kind with no registered renderer gets a minimal card with its message and Skip.

The approval card offers more, and sends more¶

Who: everyone using the built-in approval card, and custom approval renderers.

New options: Allow for this chat and Always allow appear when the agent offers them (kaboo-workflows 0.27 with a host that remembers decisions, or a tool that enforces its own approvals); approvalScopes on KabooProvider narrows them for the app. "Applies to …" above them names what they cover (reason.subject.label).
Deny replaces Reject, with an optional reason. It is sent through onResolve({ status: "cancelled", reason }), not onCancel(). onCancel() now means skip.
Approve sends a scope: { status: "approved", scope: "once" }.
Approve all / Deny all appear with two or more approvals waiting.
Deadlines are read from reason.expiresAt (the request's metadata); an expired card offers only Dismiss.
Tool-requested approvals (kaboo-workflows' interrupt.tool_approvals) render on the same card; reason.request carries the tool's request ID for the host, and the card needs no change.

Custom approval cards keep these by rendering ApprovalActions or using useApprovalDecision:

  function MyApproval(props: InterruptRendererProps) {
-   return <button onClick={() => props.onResolve({ status: "approved" })}>OK</button>;
+   return <ApprovalActions {...(props as InterruptRendererProps<ApprovalReason>)} />;
  }

Sending a message skips what is waiting¶

Who: everyone; no code change.

Before, a message sent while a question or approval was open was refused by the AG-UI client and silently lost. Now the handler drops the stale requests just before the run starts, and the agent closes them as skipped and answers the message. Remove any composer workaround that blocked sending.

Types¶

FormQuestion is { question, options, multiple? }; type is deprecated and read only when multiple is absent. toFormQuestion reads either shape.
InterruptRendererProps<R> takes the reason it handles; it defaults to the built-in kinds.
InterruptRenderers (and interruptRenderers) is keyed by any request kind.
ApprovalReason gains subject, scopes, expiresAt and request; ApprovalDecision, ApprovalScope, ApprovalSubject and CustomRequestReason are new.
useInterruptBridge() adds answered and markAnswered.

Wording¶

The answered Q&A card labels a question the person skipped "Skipped" (was "Declined by user"). isCancelledResult recognises the agent's new notes ("Declined", "Skipped", "Expired", "The person skipped this question").