Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ToolDefinitionConfig.md

84 lines2.0 KB

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

Defined in: activities/chat/tools/tool-definition.ts:88

Tool definition configuration

Type Parameters

TInput

TInput extends SchemaInput = z.ZodType

TOutput

TOutput extends SchemaInput = z.ZodType

TName

TName extends string = string

Properties

description

description: string;

Defined in: activities/chat/tools/tool-definition.ts:94


inputSchema?

optional inputSchema: TInput;

Defined in: activities/chat/tools/tool-definition.ts:95


metadata?

optional metadata: Record<string, any>;

Defined in: activities/chat/tools/tool-definition.ts:98


name

name: TName;

Defined in: activities/chat/tools/tool-definition.ts:93


needsApproval?

optional needsApproval: boolean;

Defined in: activities/chat/tools/tool-definition.ts:97


outputSchema?

optional outputSchema: TOutput;

Defined in: activities/chat/tools/tool-definition.ts:96