kotlin-sdk-core/io.modelcontextprotocol.kotlin.sdk.types/ElicitRequest

ElicitRequest

data class ElicitRequest(val params: ElicitRequestParams) : ServerRequest(source)

Represents an elicitation/create request from the server to the client.

Supports two modes: form mode (ElicitRequestFormParams) for collecting structured data in-band, and URL mode (ElicitRequestURLParams) for directing the user to an external URL.

Constructors

constructor(params: ElicitRequestParams)

Properties

val message: String

The message to present to the user. This should clearly explain what information is being requested and why.

val meta: RequestMeta?

Metadata for this request. May include a progressToken for out-of-band progress notifications.

open override val method: Method

the request method identifier

open override val params: ElicitRequestParams

The elicitation parameters — either form or URL mode.

requestedSchema

val ~~requestedSchema~~: ElicitRequestParams.RequestedSchema?

A restricted subset of JSON Schema defining the structure of the requested data.

Functions

fun Request.toJSON(): JSONRPCRequest

Converts the request to a JSON-RPC request.