Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.spec

Record Class McpSchema.ProgressNotification

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Record Components:
progressToken - A unique token to identify the progress notification. MUST be unique across all active requests.
progress - A value indicating the current progress.
total - An optional total amount of work to be done, if known.
message - An optional message providing additional context about the progress.
meta - See specification for notes on _meta usage
All Implemented Interfaces:
McpSchema.Notification
Enclosing class:
McpSchema
public static record McpSchema.ProgressNotification(String progressToken, Double progress, Double total, String message, Map<String,Object> meta) extends Record implements McpSchema.Notification
The Model Context Protocol (MCP) supports optional progress tracking for long-running operations through notification messages. Either side can send progress notifications to provide updates about operation status.

  • Constructor Details

    • ProgressNotification

      public ProgressNotification(String progressToken, double progress, Double total, String message)

    • ProgressNotification

      public ProgressNotification(String progressToken, Double progress, Double total, String message, Map<String,Object> meta)
      Creates an instance of a ProgressNotification record class.
      Parameters:
      progressToken - the value for the progressToken record component
      progress - the value for the progress record component
      total - the value for the total record component
      message - the value for the message record component
      meta - the value for the meta record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • progressToken

      public String progressToken()
      Returns the value of the progressToken record component.
      Returns:
      the value of the progressToken record component

    • progress

      public Double progress()
      Returns the value of the progress record component.
      Returns:
      the value of the progress record component

    • total

      public Double total()
      Returns the value of the total record component.
      Returns:
      the value of the total record component

    • message

      public String message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • meta

      public Map<String,Object> meta()
      Returns the value of the meta record component.
      Specified by:
      meta in interface McpSchema.Notification
      Returns:
      the value of the meta record component