ToolResult
Defined in: packages/sdk/src/tools/types.ts:116
What a tool returns. content is what the model reads, details is for logs and user interfaces, and
structured is typed data for your code; only content reaches the model. isError marks a failure for the model.
terminate asks the run to end after this step. pause asks the user a question: the call then waits for the
answer, which reaches the model as its result. outcome reports what a write did: any kind except applied sets
isError, and the model reads the outcome’s sentence and fields before content.
Type Parameters
Section titled “Type Parameters”S = unknown
Properties
Section titled “Properties”content
Section titled “content”
readonlycontent: readonlyModelContent[]
Defined in: packages/sdk/src/tools/types.ts:117
details?
Section titled “details?”
readonlyoptionaldetails?:unknown
Defined in: packages/sdk/src/tools/types.ts:118
isError?
Section titled “isError?”
readonlyoptionalisError?:boolean
Defined in: packages/sdk/src/tools/types.ts:120
outcome?
Section titled “outcome?”
readonlyoptionaloutcome?:WriteOutcome
Defined in: packages/sdk/src/tools/types.ts:123
pause?
Section titled “pause?”
readonlyoptionalpause?:object
Defined in: packages/sdk/src/tools/types.ts:122
readonlykind:"clarification"
question
Section titled “question”
readonlyquestion:string
structured?
Section titled “structured?”
readonlyoptionalstructured?:S
Defined in: packages/sdk/src/tools/types.ts:119
terminate?
Section titled “terminate?”
readonlyoptionalterminate?:boolean
Defined in: packages/sdk/src/tools/types.ts:121
These docs are licensedCC BY 4.0. Thelicence text is in the repository.