ToolDefinitionConfig | TanStack AI Docs

type ToolDefinitionConfig<TInput, TOutput, TName, TNeedsApproval, TApprovalSchema> = object & ApprovalConfig<TNeedsApproval, TApprovalSchema>;

type ToolDefinitionConfig<TInput, TOutput, TName, TNeedsApproval, TApprovalSchema> = object & ApprovalConfig<TNeedsApproval, TApprovalSchema>;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:215

Tool definition configuration

Type Declaration

description

description: string;

description: string;

execution?

optional execution?: "task";

optional execution?: "task";

inputSchema?

optional inputSchema?: TInput;

optional inputSchema?: TInput;

lazy?

optional lazy?: boolean;

optional lazy?: boolean;

metadata?

optional metadata?: Record<string, unknown>;

optional metadata?: Record<string, unknown>;

name

name: TName;

name: TName;

outputSchema?

optional outputSchema?: TOutput;

optional outputSchema?: TOutput;

replay?

optional replay?: "safe" | "never";

optional replay?: "safe" | "never";

Whether a host may run this tool again after a crash cut the run between the call and its result. 'safe' runs it again. Omit the field, or set 'never', when a second run is not safe. The host writes the model note. chat() does not read this field.

Type Parameters

TInput

TInput extends SchemaInput | undefined = undefined

TOutput

TOutput extends SchemaInput | undefined = undefined

TName

TName extends string = string

TNeedsApproval

TNeedsApproval extends boolean = false

TApprovalSchema

TApprovalSchema extends ApprovalSchemaConfig | undefined = undefined