Package dev.tachyonmcp.api.server.features.tools

Record Class ToolResult.InputRequired

java.lang.Object
java.lang.Record
dev.tachyonmcp.api.server.features.tools.ToolResult.InputRequired
Record Components:
request - the requested inputs and opaque state to echo back
All Implemented Interfaces:
ToolResult
Enclosing interface:
ToolResult
public static record ToolResult.InputRequired(InputRequestBundle request) extends Record implements ToolResult
Signals that completing the tool call requires additional input from the caller.

  • Constructor Details

    • InputRequired

      public InputRequired(InputRequestBundle request)
      Creates an instance of a InputRequired record class.
      Parameters:
      request - the value for the request record component

  • Method Details

    • inputRequests

      public Map<String,? extends InputRequest> inputRequests()
      Returns the requested inputs, keyed by request id.

    • requestState

      public @Nullable String requestState()
      Returns the opaque state token to echo back with the caller's response, or null.

    • 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.

    • request

      public InputRequestBundle request()
      Returns the value of the request record component.
      Returns:
      the value of the request record component