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

ElicitRequestURLParams

data class ElicitRequestURLParams(val message: String, val elicitationId: String, val url: String, val task: TaskMetadata? = null, val meta: RequestMeta? = null) : ElicitRequestParams(source)

Represents URL mode parameters for an elicitation/create request.

Directs the user to an external URL for out-of-band interactions (e.g., OAuth flows, payment processing, or entering sensitive credentials) that must not pass through the MCP client.

Handling the url is the responsibility of the host application: it should require HTTPS, clearly display the target domain, obtain explicit user consent, and open the URL in a secure browser context. The SDK neither opens, fetches, nor validates the URL. URLs must only appear in URL-mode requests — never render a URL from a form-mode request as a clickable link.

Constructors

ElicitRequestURLParams

constructor(message: String, elicitationId: String, url: String, task: TaskMetadata? = null, meta: RequestMeta? = null)

Properties

elicitationId

val elicitationId: String

A unique identifier for this elicitation. The client MUST treat this ID as an opaque value.

message

open override val message: String

The message explaining why the interaction is needed.