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

ProgressNotificationParams

data class ProgressNotificationParams(val progressToken: ProgressToken, val progress: Double, val total: Double? = null, val message: String? = null, val meta: JsonObject? = null) : NotificationParams(source)

Parameters for a notifications/progress notification.

Constructors

ProgressNotificationParams

constructor(progressToken: ProgressToken, progress: Double, total: Double? = null, message: String? = null, meta: JsonObject? = null)

Properties

open val ~~_meta~~: JsonObject

val message: String?

An optional message describing the current progress.

@SerialName(value = "_meta")

open override val meta: JsonObject?

Optional metadata for this notification.

val progress: Double

The progress thus far. This should increase every time progress is made, even if the total is unknown.

val progressToken: ProgressToken

The progress token which was given in the initial request, used to associate this notification with the request that is proceeding.

val total: Double?

Total number of items to process (or total progress required), if known.