Documentation
Framework
Version
Class References
Function References
Interface References
Type Alias References
Variable References

ToolDefinitionConfig

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

Defined in: tools/tool-definition.ts:79

Tool definition configuration

Type Parameters

TInput

TInput extends z.ZodType = z.ZodType

TOutput

TOutput extends z.ZodType = z.ZodType

TName

TName extends string = string

Properties

description

ts
description: string;
description: string;

Defined in: tools/tool-definition.ts:85


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

Defined in: tools/tool-definition.ts:86


metadata?

ts
optional metadata: Record<string, any>;
optional metadata: Record<string, any>;

Defined in: tools/tool-definition.ts:89


name

ts
name: TName;
name: TName;

Defined in: tools/tool-definition.ts:84


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

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


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

Defined in: tools/tool-definition.ts:87