Header menu logo Nao

ToolSchema Type

Rich schema definition for a tool, extending the basic Tool type

Record fields

Record Field Description

Category

Full Usage: Category

Field type: string option

Category/namespace for grouping related tools

Field type: string option

CostCategory

Full Usage: CostCategory

Field type: ToolCostCategory

Estimated cost category for invocation

Field type: ToolCostCategory

Description

Full Usage: Description

Field type: string

Human-readable description of what the tool does

Field type: string

Examples

Full Usage: Examples

Field type: ToolExample list

Example invocations with expected results

Field type: ToolExample list

IsSideEffectFree

Full Usage: IsSideEffectFree

Field type: bool

Whether the tool has side effects (read-only vs write)

Field type: bool

Name

Full Usage: Name

Field type: string

Unique tool name

Field type: string

Parameters

Full Usage: Parameters

Field type: ToolParameter list

Input parameters schema

Field type: ToolParameter list

ReturnDescription

Full Usage: ReturnDescription

Field type: string option

Description of the return value

Field type: string option

Version

Full Usage: Version

Field type: string option

Version identifier

Field type: string option

Type something to start searching.