Interface StructuredToolParams

Schema for defining tools.

Version

0.2.19

interface StructuredToolParams {
    description?: string;
    name: string;
    schema: ZodObjectAny | ZodEffects<ZodObjectAny, any, {}>;
}

Hierarchy

Pick<StructuredToolInterface, "name" | "schema">
- StructuredToolParams

Index

Properties

description? name schema

Properties

`Optional`description

description?: string

An optional description of the tool to pass to the model.

name

name: string

The name of the tool.

schema

schema: ZodObjectAny | ZodEffects<ZodObjectAny, any, {}>

A Zod schema representing the parameters of the tool.