Package dev.tachyonmcp.api.runtime

Record Class ElicitationRequest

java.lang.Object
java.lang.Record
dev.tachyonmcp.api.runtime.ElicitationRequest
Record Components:
message - the message to present to the user describing what information is being requested
requestedSchema - a restricted JSON Schema (top-level primitive properties only) describing the requested form
public record ElicitationRequest(String message, JsonSchema requestedSchema) extends Record
A request to elicit additional information from the user via the client, in form mode.

  • Constructor Details

    • ElicitationRequest

      public ElicitationRequest(String message, JsonSchema requestedSchema)
      Creates an instance of a ElicitationRequest record class.
      Parameters:
      message - the value for the message record component
      requestedSchema - the value for the requestedSchema 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.

    • message

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

    • requestedSchema

      public JsonSchema requestedSchema()
      Returns the value of the requestedSchema record component.
      Returns:
      the value of the requestedSchema record component