agents-tools/ai.koog.agents.core.tools.schema

Package-level declarations

Types

ToolParameterInfo

class ToolParameterInfo(val type: ToolParameterType, val description: String)

Helper class holding information about the ToolParameterType along with its optional description.

Properties

defaultJsonSchemaConfig

val defaultJsonSchemaConfig: JsonSchemaConfig

Functions

getJsonSchema

expect fun getJsonSchema(typeToken: TypeToken, jsonSchemaConfig: JsonSchemaConfig = defaultJsonSchemaConfig): JsonSchema

actual fun getJsonSchema(typeToken: TypeToken, jsonSchemaConfig: JsonSchemaConfig): JsonSchema

getToolDescriptor

fun getToolDescriptor(argsType: TypeToken, toolName: String, toolDescription: String? = null, jsonSchemaConfig: JsonSchemaConfig = defaultJsonSchemaConfig): ToolDescriptor

Generates a ToolDescriptor by generating and converting the JSON schema for the type defined by the provided argsType

fun getToolDescriptor(callable: KCallable<*>, toolName: String? = null, toolDescription: String? = null, jsonSchemaConfig: JsonSchemaConfig = defaultJsonSchemaConfig): ToolDescriptor

Generates a ToolDescriptor by generating and converting the function calling schema for the provided callable

toToolParameter

fun PropertyDefinition.toToolParameter(defs: Map<String, PropertyDefinition>?): ToolParameterInfo

Converts a JSON schema property representation PropertyDefinition to ToolParameterInfo, containing our tool parameter representation ToolParameterType along with its optional description.