0.1.0

agents-ext/ai.koog.agents.ext.tool/ExitTool

ExitTool

object ExitTool : SimpleTool<ExitTool.Args> (source)

An object representing the exit tool, primarily intended for ending conversations upon user request or based on agent decision. This tool finalizes interactions with a provided message.

The tool utilizes a structured set of arguments, which includes the final message of the agent to provide closure to the conversation. It returns the result as a standardized string, signaling the execution has been completed.

The descriptor defines the tool's metadata including its name, description, and required parameters.

Types

@Serializable

data class Args(val message: String) : Tool.Args

Properties

open override val argsSerializer: KSerializer<ExitTool.Args>

open override val descriptor: ToolDescriptor

val name: String

Functions

fun decodeArgs(rawArgs: JsonObject): ExitTool.Args

decodeArgsFromString

fun decodeArgsFromString(rawArgs: String): ExitTool.Args

open suspend override fun doExecute(args: ExitTool.Args): String

fun encodeArgs(args: ExitTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: ExitTool.Args): String

encodeResultToString

open override fun encodeResultToString(result: ToolResult.Text): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: ToolResult): String

executeAndSerialize

suspend fun executeAndSerialize(args: ExitTool.Args, enabler: DirectToolCallsEnabler): Pair<ToolResult.Text, String>

suspend fun executeUnsafe(args: Any?, enabler: DirectToolCallsEnabler): ToolResult.Text