Interface ToolConfig<I, O>

Configuration for a tool.

interface ToolConfig<I extends z.ZodTypeAny, O extends z.ZodTypeAny> {
    description: string;
    inputJsonSchema?: JSONSchema7;
    inputSchema?: I;
    metadata?: Record<string, any>;
    name: string;
    outputJsonSchema?: JSONSchema7;
    outputSchema?: O;
}

Type Parameters

Properties

description inputJsonSchema? inputSchema? metadata? name outputJsonSchema? outputSchema?

Properties

description

description: string

Description of the tool. This is passed to the model to help understand what the tool is used for.

OptionalinputJsonSchema

inputJsonSchema?: JSONSchema7

Input JSON schema. Mutually exclusive with inputSchema.

OptionalinputSchema

inputSchema?: I

Input Zod schema. Mutually exclusive with inputJsonSchema.

Optionalmetadata

metadata?: Record<string, any>

Metadata to be passed to the tool.

name

name: string

Unique name of the tool to use as a key in the registry.

OptionaloutputJsonSchema

outputJsonSchema?: JSONSchema7

Output JSON schema. Mutually exclusive with outputSchema.

OptionaloutputSchema

outputSchema?: O

Output Zod schema. Mutually exclusive with outputJsonSchema.

Settings

Member Visibility

On This Page

Properties