Interface CustomTool

A custom tool that processes input using a specified format. Learn more about custom tools.

interface CustomTool {
    description?: string;
    format?: CustomToolInputFormat;
    name: string;
    type: "custom";
}

Properties

description?: string

Optional description of the custom tool, used to provide more context.

format?: CustomToolInputFormat

The input format for the custom tool. Default is unconstrained text.

name: string

The name of the custom tool, used to identify it in tool calls.

type: "custom"

The type of the custom tool. Always custom.