Class ProgressNotification

Namespace

ModelContextProtocol.Protocol.Messages

Assembly

ModelContextProtocol.dll

Represents an out-of-band notification used to inform the receiver of a progress update for a long-running request.

[JsonConverter(typeof(ProgressNotification.Converter))]
public class ProgressNotification

Inheritance

object

ProgressNotification

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

See the schema for more details.

Properties

Progress

Gets or sets the progress thus far.

public required ProgressNotificationValue Progress { get; init; }

Property Value

ProgressNotificationValue

Remarks

This should increase for each notification issued as part of the same request, even if the total is unknown.

ProgressToken

Gets or sets the progress token which was given in the initial request, used to associate this notification with the corresponding request.

public required ProgressToken ProgressToken { get; init; }

Property Value

ProgressToken

Remarks

This token acts as a correlation identifier that links progress updates to their corresponding request.

When an endpoint initiates a request with a ProgressToken in its metadata, the receiver can send progress notifications using this same token. This allows both sides to correlate the notifications with the original request.