Interface: ClientToolDefinition

Client tool definition - sent by clients to declare available tools. Simplified interface for client-provided tools.

Note: This is the platform-independent structure. Backend-specific fields (like providerOptions) are added when converting to ToolDefinition.

Properties

optional defaultResult: ContentBlock[]

Default result when requiresResponse is false. Default: [{ type: 'text', text: '[{name} rendered on client]' }]

description: string

Tool description for the model

input: Record<string, unknown>

JSON Schema for tool input

optional intent: ToolIntent

Tool intent (render, action, compute). Default: RENDER (most client tools render UI)

name: string

Tool name

optional output: Record<string, unknown>

Optional JSON Schema for tool output (for validation/documentation)

optional requiresResponse: boolean

Whether server should wait for client response. Default: false (render tools return default result immediately)

optional timeout: number

Timeout in ms when waiting for response. Default: 30000