kotlin-sdk-core/io.modelcontextprotocol.kotlin.sdk.shared/RequestOptions

RequestOptions

class RequestOptions(relatedRequestId: RequestId? = null, resumptionToken: String? = null, onResumptionToken: (String) -> Unit? = null, val onProgress: ProgressCallback? = null, val timeout: Duration = DEFAULT_REQUEST_TIMEOUT) : TransportSendOptions(source)

Options that can be given per request.

Parameters

relatedRequestId

if present, used to indicate to the transport which incoming request to associate this outgoing message with.

resumptionToken

the resumption token used to continue long-running requests that were interrupted. Allows clients to reconnect and continue from where they left off, if supported by the transport.

onResumptionToken

callback invoked when the resumption token changes, if supported by the transport. Allows clients to persist the latest token for potential reconnection.

Constructors

RequestOptions

constructor(relatedRequestId: RequestId? = null, resumptionToken: String? = null, onResumptionToken: (String) -> Unit? = null, onProgress: ProgressCallback? = null, timeout: Duration = DEFAULT_REQUEST_TIMEOUT)

Properties

onProgress

val onProgress: ProgressCallback?

callback for progress notifications. If set, requests progress notifications from the remote end (if supported); when progress notifications are received, this callback is invoked.

onResumptionToken

val onResumptionToken: (String) -> Unit?

a callback that is invoked when the resumption token changes, if supported by the transport. This allows clients to persist the latest token for potential reconnection.

relatedRequestId

val relatedRequestId: RequestId?

if present, relatedRequestId is used to indicate to the transport which incoming request to associate this outgoing message with.

resumptionToken

val resumptionToken: String?

the resumption token used to continue long-running requests that were interrupted. This allows clients to reconnect and continue from where they left off, if supported by the transport.

timeout

val timeout: Duration

a timeout for this request. If exceeded, a McpException with code RequestTimeout is raised from Protocol.request. If not specified, DEFAULT_REQUEST_TIMEOUT is used.

Functions

component1

operator fun component1(): RequestId?

Destructuring component for relatedRequestId.

component2

operator fun component2(): String?

Destructuring component for resumptionToken.

component3

operator fun component3(): (String) -> Unit?

Destructuring component for onResumptionToken.

component4

operator fun component4(): ProgressCallback?

Destructuring component for onProgress.

component5

operator fun component5(): Duration

Destructuring component for timeout.

copy

fun copy(relatedRequestId: RequestId? = this.relatedRequestId, resumptionToken: String? = this.resumptionToken, onResumptionToken: (String) -> Unit? = this.onResumptionToken, onProgress: ProgressCallback? = this.onProgress, timeout: Duration = this.timeout): RequestOptions

Creates a copy of this RequestOptions with the specified fields replaced.

open fun copy(relatedRequestId: RequestId? = this.relatedRequestId, resumptionToken: String? = this.resumptionToken, onResumptionToken: (String) -> Unit? = this.onResumptionToken): TransportSendOptions

Creates a copy of this TransportSendOptions with the specified fields replaced.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String