http4k-ai-mcp-core/org.http4k.ai.mcp.model

Package-level declarations

Types

@JsonSerializable

data class Annotations(val audience: List<Role>? = null, val priority: Priority? = null, val lastModified: Instant? = null)

CapabilitySpec

sealed interface CapabilitySpec

Completion

@JsonSerializable

data class Completion(val values: List<String>, val total: Int? = null, val hasMore: Boolean? = null)

CompletionArgument

@JsonSerializable

data class CompletionArgument(val name: String, val value: String)

CompletionContext

@JsonSerializable

data class CompletionContext(val arguments: Map<String, String> = emptyMap())

CompletionStatus

enum CompletionStatus : Enum<CompletionStatus>

Content

@JsonSerializable

@Polymorphic(labelKey = "type")

sealed class Content

Cursor

typealias Cursor = String

Domain

class Domain : AbstractValue<String>

Elicitation

object Elicitation

ElicitationAction

enum ElicitationAction : Enum<ElicitationAction>

ElicitationContentLensSpec

class ElicitationContentLensSpec<OUT : ElicitationModel>(example: OUT, json: ConfigurableMoshi = McpJson)

ElicitationId

class ElicitationId : AbstractValue<String>

ElicitationLensSpec

open class ElicitationLensSpec<OUT>(paramMeta: ParamMeta, metadata: Map<String, MoshiNode> = emptyMap(), get: LensGet<ElicitationResponse.Ok, OUT>, set: LensSet<ElicitationResponse.Ok, OUT>, toSchema: McpCapabilityLens<ElicitationResponse.Ok, *>.(Map<String, MoshiNode>) -> McpNodeType)

ElicitationModel

abstract class ElicitationModel

Superclass for all elicitation models. Creates a JSON schema for the model and provides properties for defining the model's fields.

ElicitationModelStringReadWriteProperty

class ElicitationModelStringReadWriteProperty<T>(get: (String) -> Any?, set: (String, T?) -> Unit, val title: String, val description: String, val type: ParamMeta, val required: Boolean, val default: Any?, val metadata: List<Elicitation.Metadata<in T, *>>) : ReadWriteProperty<ElicitationModel, T>

Icon

@JsonSerializable

data class Icon(val src: Uri, val mimeType: MimeType? = null, val sizes: List<IconSize> = emptyList(), val theme: IconTheme? = null)

IconSize

@JsonSerializable

data class IconSize(val value: String)

IconTheme

enum IconTheme : Enum<IconTheme>

LogLevel

enum LogLevel : Enum<LogLevel>

McpCapabilityLens

class McpCapabilityLens<IN : Any, OUT>(meta: Meta, get: (IN) -> OUT, set: (OUT, IN) -> IN, toSchema: (McpCapabilityLens<IN, *>) -> McpNodeType) : LensInjectorExtractor<IN, OUT> , BiDiLens<IN, OUT>

McpEntity

class McpEntity : AbstractValue<String> , CapabilitySpec

Represents the name of the MCP entity. Used for identification and matching purposes.

McpMessageId

class McpMessageId : AbstractValue<Long>

Message

@JsonSerializable

data class Message(val role: Role, val content: Content)

Properties

end_turn

val StopReason.Companion.end_turn: StopReason

max_tokens

val StopReason.Companion.max_tokens: StopReason

stop_sequence

val StopReason.Companion.stop_sequence: StopReason

tool_use

val StopReason.Companion.tool_use: StopReason

Functions

base64

fun Elicitation.base64(): ElicitationLensSpec<String>

fun Tool.Arg.base64(): ToolArgLensSpec<String>

boolean

fun Elicitation.boolean(): ElicitationLensSpec<Boolean>

fun Tool.Arg.boolean(): ToolArgLensSpec<Boolean>

dateTime

fun Elicitation.dateTime(formatter: DateTimeFormatter = ISO_LOCAL_DATE_TIME): ElicitationLensSpec<LocalDateTime?>

fun Tool.Arg.dateTime(formatter: DateTimeFormatter = ISO_LOCAL_DATE_TIME): ToolArgLensSpec<LocalDateTime?>

double

fun Tool.Arg.double(): ToolArgLensSpec<Double>

duration

fun Elicitation.duration(): ElicitationLensSpec<Duration?>

fun Tool.Arg.duration(): ToolArgLensSpec<Duration?>

enum

inline fun <T : Enum<T>> Elicitation.enum(): ElicitationLensSpec<T>

inline fun <T : Enum<T>> Tool.Arg.enum(): ToolArgLensSpec<T>

enums

inline fun <T : Enum<T>> Elicitation.enums(): ElicitationLensSpec<List<T>>

float

fun Tool.Arg.float(): ToolArgLensSpec<Float>

instant

fun Elicitation.instant(): ElicitationLensSpec<Instant?>

fun Tool.Arg.instant(): ToolArgLensSpec<Instant?>

int

fun Elicitation.int(): ElicitationLensSpec<Long>

fun Tool.Arg.int(): ToolArgLensSpec<Int>

localDate

fun Elicitation.localDate(formatter: DateTimeFormatter = ISO_LOCAL_DATE): ElicitationLensSpec<LocalDate?>

fun Tool.Arg.localDate(formatter: DateTimeFormatter = ISO_LOCAL_DATE): ToolArgLensSpec<LocalDate?>

locale

fun Elicitation.locale(): ElicitationLensSpec<Locale>

fun Tool.Arg.locale(): ToolArgLensSpec<Locale>

localTime

fun Elicitation.localTime(formatter: DateTimeFormatter = ISO_LOCAL_TIME): ElicitationLensSpec<LocalTime?>

fun Tool.Arg.localTime(formatter: DateTimeFormatter = ISO_LOCAL_TIME): ToolArgLensSpec<LocalTime?>

long

fun Tool.Arg.long(): ToolArgLensSpec<Long>

map

fun <NEXT, OUT> ToolArgLensSpec<OUT>.map(mapping: BiDiMapping<OUT, NEXT>): ToolArgLensSpec<NEXT>

fun <NEXT, OUT> ElicitationLensSpec<OUT>.map(mapping: BiDiMapping<OUT, NEXT>, newMetadata: Map<String, MoshiNode> = emptyMap()): ElicitationLensSpec<NEXT>

nonBlankString

fun Elicitation.nonBlankString(): ElicitationLensSpec<String>

fun Tool.Arg.nonBlankString(): ToolArgLensSpec<String>

nonEmptyString

fun Elicitation.nonEmptyString(): ElicitationLensSpec<String>

Typesafe extension functions for creating Elicitation lenses.

fun Tool.Arg.nonEmptyString(): ToolArgLensSpec<String>

number

fun Elicitation.number(): ElicitationLensSpec<BigDecimal>

offsetDateTime

fun Elicitation.offsetDateTime(formatter: DateTimeFormatter = ISO_OFFSET_DATE_TIME): ElicitationLensSpec<OffsetDateTime?>

fun Tool.Arg.offsetDateTime(formatter: DateTimeFormatter = ISO_OFFSET_DATE_TIME): ToolArgLensSpec<OffsetDateTime?>

offsetTime

fun Elicitation.offsetTime(formatter: DateTimeFormatter = ISO_OFFSET_TIME): ElicitationLensSpec<OffsetTime?>

fun Tool.Arg.offsetTime(formatter: DateTimeFormatter = ISO_OFFSET_TIME): ToolArgLensSpec<OffsetTime?>

paramMeta

inline fun <T : Any> paramMeta(): ParamMeta

period

fun Elicitation.period(): ElicitationLensSpec<Period?>

fun Tool.Arg.period(): ToolArgLensSpec<Period?>

regexObject

fun Elicitation.regexObject(): ElicitationLensSpec<Regex>

fun Tool.Arg.regexObject(): ToolArgLensSpec<Regex>

status

fun Tool.Arg.status(): ToolArgLensSpec<Status>

string

fun Elicitation.string(): ElicitationLensSpec<String>

fun Tool.Arg.string(): ToolArgLensSpec<String>

Typesafe extension functions for creating tool argument lenses.

toSchema

fun Meta.toSchema(): McpNodeType

fun ParamMeta.toSchema(description: String?, metadata: Map<String, Any>): McpNodeType

uri

fun Elicitation.uri(): ElicitationLensSpec<Uri>

fun Tool.Arg.uri(): ToolArgLensSpec<Uri>

urlEncoded

fun Elicitation.urlEncoded(): ElicitationLensSpec<String>

fun Tool.Arg.urlEncoded(): ToolArgLensSpec<String>

uuid

fun Elicitation.uuid(): ElicitationLensSpec<UUID?>

fun Tool.Arg.uuid(): ToolArgLensSpec<UUID?>

value

fun Tool.Arg.value(): ToolArgLensSpec<Int>

inline fun <VALUE : Value<T>, T : Any> Elicitation.value(vf: ValueFactory<VALUE, T>): ElicitationLensSpec<VALUE>

inline fun <VALUE : Value<T>, T : Any> Tool.Arg.value(vf: ValueFactory<VALUE, T>): ToolArgLensSpec<VALUE>

yearMonth

fun Elicitation.yearMonth(): ElicitationLensSpec<YearMonth?>

fun Tool.Arg.yearMonth(): ToolArgLensSpec<YearMonth?>

zonedDateTime

fun Elicitation.zonedDateTime(formatter: DateTimeFormatter = ISO_ZONED_DATE_TIME): ElicitationLensSpec<ZonedDateTime?>

fun Tool.Arg.zonedDateTime(formatter: DateTimeFormatter = ISO_ZONED_DATE_TIME): ToolArgLensSpec<ZonedDateTime?>

zoneId

fun Elicitation.zoneId(): ElicitationLensSpec<ZoneId?>

fun Tool.Arg.zoneId(): ToolArgLensSpec<ZoneId?>

zoneOffset

fun Elicitation.zoneOffset(): ElicitationLensSpec<ZoneOffset?>

fun Tool.Arg.zoneOffset(): ToolArgLensSpec<ZoneOffset?>