Skip to main content

ModelToolCallOptions

@forge/monorepo


@forge/monorepo / backend/src / ModelToolCallOptions

Type Alias: ModelToolCallOptions

ModelToolCallOptions = object

Defined in: backend/src/models/streaming.ts:101

What the provider tells us about a call it is making.

Only the id, and only because a wrapper needs a key: an execution that resolved to a different tool than the one the model named — execute_tool — has to be able to say which call it was, or the run event log records the indirection and loses the action.

Properties

report?

readonly optional report?: (fact) => void

Defined in: backend/src/models/streaming.ts:111

Report what actually ran, when it is not the tool the model named.

Best effort by construction: the platform's execution path knows the fact and the host's execute closure is the only thing standing between the two, so a host that does not call this leaves the field absent. Absent therefore means "nobody reported an indirection", not "there was none" — which is why the run event log keeps the model's own tool name as the primary record and treats this as an addition to it.

Parameters

fact
ranToolName

string

Returns

void


toolCallId?

readonly optional toolCallId?: string

Defined in: backend/src/models/streaming.ts:102