Skip to main content

ToolSpec

Agent Runtimes

Agent Runtimes / types/tools / ToolSpec

Interface: ToolSpec

Defined in: types/tools.ts:21

Specification for a runtime tool.

Properties​

approval​

approval: "auto" | "manual"

Defined in: types/tools.ts:35

Approval policy for this tool

description​

description: string

Defined in: types/tools.ts:29

Tool description

emoji?​

optional emoji?: string

Defined in: types/tools.ts:45

Emoji identifier

enabled​

enabled: boolean

Defined in: types/tools.ts:33

Whether the tool is enabled

icon?​

optional icon?: string

Defined in: types/tools.ts:43

Icon identifier

id​

id: string

Defined in: types/tools.ts:23

Unique tool identifier

name​

name: string

Defined in: types/tools.ts:27

Display name for the tool

requiresApproval?​

optional requiresApproval?: boolean

Defined in: types/tools.ts:39

Whether tool requires human approval before execution

runtime​

runtime: ToolRuntimeSpec

Defined in: types/tools.ts:41

Runtime binding metadata

tags​

tags: string[]

Defined in: types/tools.ts:31

Tags for categorization

timeout?​

optional timeout?: string

Defined in: types/tools.ts:37

Approval timeout duration (e.g. 0h5m0s, 2d6h, 1mo2d3h4m5s)

version?​

optional version?: string

Defined in: types/tools.ts:25

Version