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

Record Class McpSchema.PromptMessage

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.PromptMessage
Record Components:
role - The sender or recipient of messages and data in a conversation.
content - The content of the message of type McpSchema.Content.
Enclosing class:
McpSchema
public static record McpSchema.PromptMessage(McpSchema.Role role, McpSchema.Content content) extends Record
Describes a message returned as part of a prompt. This is similar to `SamplingMessage`, but also supports the embedding of resources from the MCP server.

  • Constructor Details

    • PromptMessage

      public PromptMessage(McpSchema.Role role, McpSchema.Content content)
      Creates an instance of a PromptMessage record class.
      Parameters:
      role - the value for the role record component
      content - the value for the content 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.

    • role

      public McpSchema.Role role()
      Returns the value of the role record component.
      Returns:
      the value of the role record component

    • content

      public McpSchema.Content content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component