Serializer responsible for encoding and decoding the arguments required for the tool execution. This abstract property is used to define the specific KSerializer corresponding to the type of arguments expected by the tool.

descriptor

abstract val descriptor: ToolDescriptor

Provides a descriptor detailing the tool's metadata, including its name, description, and parameter requirements. This property defines the structure and characteristics of the tool, offering an overview of its functionality and how it should be used.

name

val name: String

Represents the name property of the tool, derived from the tool's descriptor. This property provides an immutable reference to the tool's unique name, which is used for identification within tool registries.

Functions

decodeArgs

fun decodeArgs(rawArgs: JsonObject): TArgs

Decodes the provided raw JSON arguments into an instance of the specified arguments type.

decodeArgsFromString

fun decodeArgsFromString(rawArgs: String): TArgs

Decodes a raw string representation of arguments into the corresponding object of type TArgs.

encodeArgs

fun encodeArgs(args: TArgs): JsonObject

Encodes the given arguments into a JSON representation.

encodeArgsToString

fun encodeArgsToString(args: TArgs): String

Encodes the provided arguments into a JSON string representation using the configured serializer.

encodeResultToString

open fun encodeResultToString(result: TResult): String

Encodes the given result of type TResult to its string representation for the LLM.s

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: ToolResult): String

Encodes the provided result object into a JSON string representation without type safety checks.