Struct ProgressNotificationValue

Namespace

ModelContextProtocol

Assembly

ModelContextProtocol.dll

Provides a progress value that can be sent using IProgress<T>.

public record struct ProgressNotificationValue : IEquatable<ProgressNotificationValue>

Implements

IEquatable<ProgressNotificationValue>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Message

Gets or sets an optional message describing the current progress.

public string? Message { readonly get; init; }

Property Value

string

Progress

Gets or sets the progress thus far.

public required float Progress { readonly get; init; }

Property Value

float

Remarks

This value typically represents either a percentage (0-100) or the number of items processed so far (when used with the Total property).

When reporting progress, this value should increase monotonically as the operation proceeds. Values are typically between 0 and 100 when representing percentages, or can be any positive number when representing completed items in combination with the Total property.

Total

Gets or sets the total number of items to process (or total progress required), if known.

public float? Total { readonly get; init; }

Property Value

float?