Record Class McpPromptResult

java.lang.Object
java.lang.Record
com.soklet.McpPromptResult
@Immutable public record McpPromptResult(@Nullable String description, @NonNull List<@NonNull McpPromptMessage> messages) extends Record
Immutable MCP prompt result.
Author:
Mark Allen

  • Constructor Details

  • Method Details

    • fromMessages

      public static @NonNull McpPromptResult fromMessages(@NonNull McpPromptMessage... messages)
      Creates a prompt result containing only messages.
      Parameters:
      messages - the prompt messages
      Returns:
      a prompt result without a description

    • fromDescriptionAndMessages

      public static @NonNull McpPromptResult fromDescriptionAndMessages(@NonNull String description, @NonNull McpPromptMessage... messages)
      Creates a prompt result containing a description and messages.
      Parameters:
      description - the prompt result description
      messages - the prompt messages
      Returns:
      a prompt result with a description

    • 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 @Nullable String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • messages

      public @NonNull List<@NonNull McpPromptMessage> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component