Skip to main content

Function: typedToolCall()

typedToolCall<TSchema, TReturn>(segment, toolDef, options?): TypedToolCallData<InferOutput<TSchema>, TReturn>

Defined in: packages/core/src/segments/typed-tool-call.ts:35

Extract typed data from a ToolCallSegment using its ZodToolDefinition.

Generics flow automatically from the tool definition:

  • TSchema: Zod input schema -> args type
  • TReturn: Tool function return type -> result type

Type Parameters​

TSchema​

TSchema extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

TReturn​

TReturn

Parameters​

segment​

ToolCallSegment

toolDef​

ZodToolDefinition<TSchema, TReturn>

options?​

validate?​

boolean

Returns​

TypedToolCallData<InferOutput<TSchema>, TReturn>