Interface: ToolDefinition

Tool definition for registering tools with the client

Properties

code: string

Tool implementation code

description: string

Description of what the tool does

execution_type: "synchronous" | "asynchronous"

Tool execution type

optional id: string

Optional unique identifier

language: "python" | "shell"

Programming language of the code

name: string

Name of the tool

operation_mode: "client_mode" | "server_mode"

Tool operation mode

parameters: object

Parameters schema

properties: Record<string, ToolParameter>

type: "object"

platform: "linux" | "macos" | "windows"

Operating system platform

required: string[]

Required parameter names

result_handling: "process_in_llm" | "process_in_client" | "ignore_result"

How to handle the tool’s result

type: "function"

Tool type, always “function”