http4k-mcp-core/org.http4k.mcp.model/Tool/Arg

Arg

object Arg

A typesafe tool argument lens. Use the extension functions below to create a lens for a specific type.

Functions

auto

inline fun <T : Any> Tool.Arg.auto(example: T): ToolArgLensSpec<T>

Auto-marshalled lens for a tool argument. You will need Kotlin reflection on the classpath for this to work.

base64

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

boolean

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

dateTime

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

double

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

duration

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

enum

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

float

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

instant

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

int

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

localDate

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

locale

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

localTime

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

long

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

nonBlankString

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

nonEmptyString

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

offsetDateTime

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

offsetTime

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

period

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

regexObject

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

string

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

Typesafe extension functions for creating tool argument lenses.

uri

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

urlEncoded

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

uuid

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

value

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

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

yearMonth

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

zonedDateTime

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

zoneId

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

zoneOffset

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