Skip to content

defineTool

function defineTool<S, R>(config): EffectTool<InferToolInput<S>, R>;
Type Parameter Default type

S extends | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | StandardSchemaV1<unknown, unknown> | undefined

undefined

R

unknown

Parameter Type Description

config

{ description: string; estimatedDurationMs?: number; execute: (args, ctx?) => Promise<R> | AsyncIterable<R, any, any>; filler?: string; input?: S; interim?: string; interimAfterMs?: number; interruptible?: boolean; name?: string; needsApproval?: boolean; output?: StandardSchemaV1<R, R>; replay?: boolean; timeoutMs?: number; }

config.description

string

config.estimatedDurationMs?

number

config.execute

(args, ctx?) => Promise<R> | AsyncIterable<R, any, any>

config.filler?

string

config.input?

S

config.interim?

string

config.interimAfterMs?

number

config.interruptible?

boolean

config.name?

string

config.needsApproval?

boolean

config.output?

StandardSchemaV1<R, R>

config.replay?

boolean

config.timeoutMs?

number

EffectTool<InferToolInput<S>, R>