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

Record Class ToolResult.Success

java.lang.Object
java.lang.Record
dev.tachyonmcp.api.server.features.tools.ToolResult.Success
Record Components:
structuredValue - the structured payload, or null when none was set
content - the content blocks, possibly empty
All Implemented Interfaces:
ToolResult
Enclosing interface:
ToolResult
public static record ToolResult.Success(@Nullable Object structuredValue, List<ContentBlock> content) extends Record implements ToolResult
A successful invocation, carrying an optional structured value and its content blocks.

  • Constructor Details

    • Success

      public Success(@Nullable Object structuredValue, List<ContentBlock> content)
      Creates an instance of a Success record class.
      Parameters:
      structuredValue - the value for the structuredValue record component
      content - the value for the content record component

  • Method Details

    • structured

      public Optional<Object> structured()
      Returns the structured value, or empty when none was set.

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

    • structuredValue

      public @Nullable Object structuredValue()
      Returns the value of the structuredValue record component.
      Returns:
      the value of the structuredValue record component

    • content

      public List<ContentBlock> content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component