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

ElicitRequestFormParams

data class ElicitRequestFormParams(val message: String, val task: TaskMetadata? = null, val requestedSchema: ElicitRequestParams.RequestedSchema, val meta: RequestMeta? = null) : ElicitRequestParams(source)

Represents form mode parameters for an elicitation/create request.

Collects non-sensitive structured data from the user via a form presented by the client.

Constructors

ElicitRequestFormParams

constructor(message: String, task: TaskMetadata? = null, requestedSchema: ElicitRequestParams.RequestedSchema, meta: RequestMeta? = null)

Properties

open override val message: String

The message to present to the user describing what information is being requested.

@SerialName(value = "_meta")

open override val meta: RequestMeta?

Optional metadata. May include a progressToken for out-of-band progress notifications.

val mode: String

The elicitation mode discriminator, always "form".

requestedSchema

val requestedSchema: ElicitRequestParams.RequestedSchema

A restricted subset of JSON Schema. Only top-level properties are allowed, without nesting.

val task: TaskMetadata?

If specified, the caller is requesting task-augmented execution. The request will return a CreateTaskResult immediately, and the actual result can be retrieved later via tasks/result.