docs(agent): clarify parallel tool ordering closes #3468

This commit is contained in:
Mario Zechner
2026-04-20 22:35:43 +02:00
parent c40efa9bab
commit 7b1599058b
3 changed files with 10 additions and 3 deletions

View File

@@ -30,7 +30,7 @@ export type StreamFn = (
*
* - "sequential": each tool call is prepared, executed, and finalized before the next one starts.
* - "parallel": tool calls are prepared sequentially, then allowed tools execute concurrently.
* Final tool results are still emitted in assistant source order.
* Final tool lifecycle and tool-result artifacts are emitted in tool completion order.
*/
export type ToolExecutionMode = "sequential" | "parallel";
@@ -185,7 +185,8 @@ export interface AgentLoopConfig extends SimpleStreamOptions {
/**
* Tool execution mode.
* - "sequential": execute tool calls one by one
* - "parallel": preflight tool calls sequentially, then execute allowed tools concurrently
* - "parallel": preflight tool calls sequentially, then execute allowed tools concurrently;
* final tool lifecycle and tool-result artifacts are emitted in tool completion order
*
* Default: "parallel"
*/