Interface Tool

A tool declared to the runtime. parameters also accepts a Zod schema upstream.

interface Tool {
    description?: string;
    handler?: ToolHandler;
    name: string;
    parameters?: Record<string, unknown>;
    skipPermission?: boolean;
}

Index

Properties

description? handler? name parameters? skipPermission?

Properties

`Optional`description

description?: string

`Optional`handler

handler?: ToolHandler

name

name: string

`Optional`parameters

parameters?: Record<string, unknown>

`Optional`skipPermission

skipPermission?: boolean

When true, the tool runs without a permission prompt of the runtime.