Interface ToolWrapperParams<RunInput>

Parameters for the tool function.

interface ToolWrapperParams<RunInput> {
    name: string;
    callbacks?: Callbacks;
    description?: string;
    metadata?: Record<string, unknown>;
    schema?: RunInput;
    tags?: string[];
    verbose?: boolean;
}

Type Parameters

  • RunInput extends ZodAny = ZodAny

    The input schema for the tool.

Hierarchy (view full)

Properties

name callbacks? description? metadata? schema? tags? verbose?

Properties

name

name: string

The name of the tool. If using with an LLM, this will be passed as the tool name.

Optionalcallbacks

callbacks?: Callbacks

Optionaldescription

description?: string

The description of the tool.

Default

${fields.name} tool

Optionalmetadata

metadata?: Record<string, unknown>

Optionalschema

schema?: RunInput

The input schema for the tool. If using an LLM, this will be passed as the tool schema to generate arguments for.

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties