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

Record Class McpSchema.Annotations

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.Annotations
Record Components:
audience - Describes who the intended customer of this object or data is. It can include multiple entries to indicate content useful for multiple audiences (e.g., `["user", "assistant"]`).
priority - Describes how important this data is for operating the server. A value of 1 means "most important," and indicates that the data is effectively required, while 0 means "least important," and indicates that the data is entirely optional. It is a number between 0 and 1.
Enclosing class:
McpSchema
public static record McpSchema.Annotations(List<McpSchema.Role> audience, Double priority) extends Record
Optional annotations for the client. The client can use annotations to inform how objects are used or displayed.

  • Constructor Details

    • Annotations

      public Annotations(List<McpSchema.Role> audience, Double priority)
      Creates an instance of a Annotations record class.
      Parameters:
      audience - the value for the audience record component
      priority - the value for the priority 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.

    • audience

      public List<McpSchema.Role> audience()
      Returns the value of the audience record component.
      Returns:
      the value of the audience record component

    • priority

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