getcompanion-ai/co-mono
1
0
Fork 0
mirror of https://github.com/getcompanion-ai/co-mono.git synced 2026-04-18 19:03:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Forward onUpdate callback through hook wrapper (#238)

Browse source
This commit is contained in:
Nico Bailon 2025-12-19 06:23:41 -08:00 • committed by GitHub
parent 16685a36ec
commit a54c70bbed
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 45 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
packages/coding-agent/src/core/custom-tools/index.ts
View file

@ -4,6 +4,7 @@
export { discoverAndLoadCustomTools, loadCustomTools } from "./loader.js";
export type {
AgentToolUpdateCallback,
CustomAgentTool,
CustomToolFactory,
CustomToolsLoadResult,

35
packages/coding-agent/src/core/custom-tools/types.ts
View file

@ -5,7 +5,7 @@
* They can provide custom rendering for tool calls and results in the TUI.
*/
import type { AgentTool, AgentToolResult } from "@mariozechner/pi-ai";
import type { AgentTool, AgentToolResult, AgentToolUpdateCallback } from "@mariozechner/pi-ai";
import type { Component } from "@mariozechner/pi-tui";
import type { Static, TSchema } from "@sinclair/typebox";
import type { Theme } from "../../modes/interactive/theme/theme.js";
@ -15,6 +15,9 @@ import type { SessionEntry } from "../session-manager.js";
/** Alias for clarity */
export type ToolUIContext = HookUIContext;
/** Re-export for custom tools to use in execute signature */
export type { AgentToolUpdateCallback };
export interface ExecResult {
stdout: string;
stderr: string;
@ -62,7 +65,35 @@ export interface RenderResultOptions {
isPartial: boolean;
}
/** Custom tool with optional lifecycle and rendering methods */
/**
* Custom tool with optional lifecycle and rendering methods.
*
* The execute signature inherited from AgentTool includes an optional onUpdate callback
* for streaming progress updates during long-running operations:
* - The callback emits partial results to subscribers (e.g. TUI/RPC), not to the LLM.
* - Partial updates should use the same TDetails type as the final result (use a union if needed).
*
* @example
* ```typescript
* type Details =
* | { status: "running"; step: number; total: number }
* | { status: "done"; count: number };
*
* async execute(toolCallId, params, signal, onUpdate) {
* const items = params.items || [];
* for (let i = 0; i < items.length; i++) {
* onUpdate?.({
* content: [{ type: "text", text: `Step ${i + 1}/${items.length}...` }],
* details: { status: "running", step: i + 1, total: items.length },
* });
* await processItem(items[i], signal);
* }
* return { content: [{ type: "text", text: "Done" }], details: { status: "done", count: items.length } };
* }
* ```
*
* Progress updates are rendered via renderResult with isPartial: true.
*/
export interface CustomAgentTool<TParams extends TSchema = TSchema, TDetails = any>
extends AgentTool<TParams, TDetails> {
/** Called on session start/switch/branch/clear - use to reconstruct state from entries */