langchain.js
    Preparing search index...

    Interface StructuredToolParams

    Schema for defining tools.

    0.2.19

    interface StructuredToolParams {
        description?: string;
        extras?: Record<string, unknown>;
        name: string;
        schema: ToolSchemaBase;
    }

    Hierarchy

    Index

    Properties

    description? extras? name schema

    Properties

    description?: string

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

    extras?: Record<string, unknown>

    Optional provider-specific extra fields for the tool.

    This is used to pass provider-specific configuration that doesn't fit into standard tool fields.

    name: string

    The name of the tool.

    schema: ToolSchemaBase

    A Zod schema representing the parameters of the tool.

    Settings

    Member Visibility

    On This Page

    Properties