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

Record Class McpSchema.GetPromptResult

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.GetPromptResult
Record Components:
description - An optional description for the prompt.
messages - A list of messages to display as part of the prompt.
Enclosing class:
McpSchema
public static record McpSchema.GetPromptResult(String description, List<McpSchema.PromptMessage> messages) extends Record
The server's response to a prompts/get request from the client.

  • Constructor Details

    • GetPromptResult

      public GetPromptResult(String description, List<McpSchema.PromptMessage> messages)
      Creates an instance of a GetPromptResult record class.
      Parameters:
      description - the value for the description record component
      messages - the value for the messages 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.

    • description

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

    • messages

      public List<McpSchema.PromptMessage> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component