File size: 7,227 Bytes
80d7f0c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | import { type ToolResultMessage, validateToolArguments } from "@earendil-works/pi-ai";
import type { AgentToolCall, AgentToolResult } from "../../types.ts";
import { type Context, withAbortSignal } from "../context.ts";
import type { JsonValue } from "../session/types.ts";
import type { AgentHarnessTool, AgentHarnessToolInvocation, AgentHarnessToolUpdateCallback } from "../types.ts";
import type { Gate } from "./effect-gate.ts";
/** A tool call whose tool exists and whose prepared arguments passed validation. */
export interface PreparedToolCall<TContext extends object | undefined> {
toolCall: AgentToolCall;
tool: AgentHarnessTool<TContext>;
args: Record<string, JsonValue>;
}
/** Synthetic result produced without crossing the external tool-effect boundary. */
export interface ImmediateToolOutcome {
kind: "immediate";
toolCall: AgentToolCall;
result: AgentToolResult<unknown>;
isError: true;
terminate: boolean;
}
/** Aggregated decision from the before-tool hook pipeline. */
export interface BeforeToolDecision {
args?: Record<string, JsonValue>;
block?: { reason: string; terminate?: boolean };
}
/** A prepared call cleared for durable intent publication and execution. */
export interface ClearedToolCall<TContext extends object | undefined> {
toolCall: AgentToolCall;
tool: AgentHarnessTool<TContext>;
args: Record<string, JsonValue>;
}
/** Raw phase-two tool output before after-tool patching. */
export interface ExecutedToolCall {
result: AgentToolResult<unknown>;
isError: boolean;
}
/** Aggregated patch from the after-tool hook pipeline. */
export interface AfterToolPatch {
content?: AgentToolResult<unknown>["content"];
details?: JsonValue;
isError?: boolean;
usage?: AgentToolResult<unknown>["usage"];
terminate?: boolean;
}
/** Final tool output ready to become a durable tool-result message. */
export interface FinalizedToolCall {
toolCall: AgentToolCall;
result: AgentToolResult<unknown>;
isError: boolean;
terminate: boolean;
}
function createErrorToolResult(message: string): AgentToolResult<unknown> {
return {
content: [{ type: "text", text: message }],
details: undefined,
};
}
function immediateError(toolCall: AgentToolCall, message: string, terminate = false): ImmediateToolOutcome {
return {
kind: "immediate",
toolCall,
result: createErrorToolResult(message),
isError: true,
terminate,
};
}
/** Resolve a tool, apply its deterministic argument preparation, and validate the result. */
export function prepareToolCall<TContext extends object | undefined>(
call: AgentToolCall,
tools: AgentHarnessTool<TContext>[],
): PreparedToolCall<TContext> | ImmediateToolOutcome {
const tool = tools.find((candidate) => candidate.name === call.name);
if (!tool) {
return immediateError(call, `Tool ${JSON.stringify(call.name)} is unavailable`);
}
try {
const preparedArguments = tool.prepareArguments ? tool.prepareArguments(call.arguments) : call.arguments;
const preparedCall: AgentToolCall =
preparedArguments === call.arguments
? call
: { ...call, arguments: preparedArguments as Record<string, JsonValue> };
const args = validateToolArguments(tool, preparedCall) as Record<string, JsonValue>;
return { toolCall: call, tool, args };
} catch (error) {
return immediateError(call, error instanceof Error ? error.message : String(error));
}
}
/** Apply an explicit hook decision and revalidate replacement arguments. */
export function applyBeforeToolDecision<TContext extends object | undefined>(
prepared: PreparedToolCall<TContext>,
decision: BeforeToolDecision | undefined,
): ClearedToolCall<TContext> | ImmediateToolOutcome {
if (decision?.block) {
return immediateError(prepared.toolCall, decision.block.reason, decision.block.terminate === true);
}
if (!decision?.args) {
return { toolCall: prepared.toolCall, tool: prepared.tool, args: prepared.args };
}
try {
const validatedArgs = validateToolArguments(prepared.tool, {
...prepared.toolCall,
arguments: decision.args,
}) as Record<string, JsonValue>;
return { toolCall: prepared.toolCall, tool: prepared.tool, args: validatedArgs };
} catch (error) {
return immediateError(prepared.toolCall, error instanceof Error ? error.message : String(error));
}
}
/** Execute one cleared external tool effect, converting expected tool throws to error output. */
export function executeToolCall<TContext extends object | undefined>(
call: ClearedToolCall<TContext>,
gate: Gate,
onUpdate: AgentHarnessToolUpdateCallback<unknown>,
toolContext: TContext,
invocation: AgentHarnessToolInvocation,
context: Context,
): Promise<ExecutedToolCall> {
let acceptingUpdates = true;
return gate.admit(async () => {
const admittedContext = withAbortSignal(gate.signal, context);
admittedContext.abortSignal?.throwIfAborted();
try {
const result = await call.tool.execute(
call.toolCall.id,
call.args,
(partial, options) => {
if (acceptingUpdates) onUpdate(partial, options);
},
toolContext,
invocation,
admittedContext,
);
return { result, isError: false };
} catch (error) {
return {
result: createErrorToolResult(error instanceof Error ? error.message : String(error)),
isError: true,
};
} finally {
acceptingUpdates = false;
}
});
}
/** Apply an after-tool patch field by field. */
export function finalizeToolCall<TContext extends object | undefined>(
call: ClearedToolCall<TContext>,
executed: ExecutedToolCall,
patch: AfterToolPatch | undefined,
): FinalizedToolCall {
const result: AgentToolResult<unknown> = patch
? {
...executed.result,
content: patch.content === undefined ? executed.result.content : patch.content,
details: patch.details === undefined ? executed.result.details : patch.details,
usage: patch.usage === undefined ? executed.result.usage : patch.usage,
terminate: patch.terminate === undefined ? executed.result.terminate : patch.terminate,
}
: executed.result;
return {
toolCall: call.toolCall,
result,
isError: patch?.isError ?? executed.isError,
terminate: result.terminate === true,
};
}
/** Reconstruct the canonical tool result represented by a staged transcript message. */
export function toolResultFromMessage(
message: ToolResultMessage<unknown>,
terminate: boolean,
): AgentToolResult<unknown> {
return {
content: message.content,
details: message.details,
...(message.usage === undefined ? {} : { usage: message.usage }),
...(message.addedToolNames === undefined ? {} : { addedToolNames: message.addedToolNames }),
...(terminate ? { terminate: true } : {}),
};
}
/** Convert finalized tool output to the provider-facing transcript message. */
export function createToolResultMessage(call: FinalizedToolCall): ToolResultMessage {
return {
role: "toolResult",
toolCallId: call.toolCall.id,
toolName: call.toolCall.name,
content: call.result.content ?? [],
...(call.result.details === undefined ? {} : { details: call.result.details }),
...(call.result.usage === undefined ? {} : { usage: call.result.usage }),
...(call.result.addedToolNames?.length ? { addedToolNames: call.result.addedToolNames } : {}),
isError: call.isError,
timestamp: Date.now(),
};
}
|