Skip to main content

BackendToolDefinition

Agent Runtimes


Agent Runtimes / types/tools / BackendToolDefinition

Interface: BackendToolDefinition

Defined in: src/types/tools.ts:203

Backend tool definition (tool runs on server)

Properties

description

description: string

Defined in: src/types/tools.ts:208

Description for the LLM


location

location: "backend"

Defined in: src/types/tools.ts:214

Must be 'backend'


name

name: string

Defined in: src/types/tools.ts:205

Unique tool name


parameters

parameters: ToolParameter[]

Defined in: src/types/tools.ts:211

Parameter definitions


render?

optional render?: (props) => ReactNode

Defined in: src/types/tools.ts:219

Optional render function for custom UI during execution

Parameters

props

ToolRenderProps

Returns

ReactNode