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

ElicitRequest

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

A request from the server to elicit additional information from the user via the client.

This request type allows servers to prompt users for structured input through forms or dialogs presented by the client. The server defines a schema for the requested data, and the client presents an appropriate UI to collect this information.

Constructors

Link copied to clipboard
constructor(params: ElicitRequestParams)

Properties

Link copied to clipboard
val message: String

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

Link copied to clipboard
val meta: RequestMeta?

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

Link copied to clipboard
@EncodeDefault
open override val method: Method
Link copied to clipboard
open override val params: ElicitRequestParams

The elicitation parameters including the message and requested schema.

Link copied to clipboard
val requestedSchema: ElicitRequestParams.RequestedSchema

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

Functions

Link copied to clipboard
fun Request.toJSON(): JSONRPCRequest
fun Request.toJSON(): JSONRPCRequest

Converts the request to a JSON-RPC request.

Generated by Dokka
Copyright © 2024-2025 Anthropic, PBC