Package io.openliberty.mcp.tools

Record Class ToolResponse

java.lang.Object
java.lang.Record
io.openliberty.mcp.tools.ToolResponse
Record Components:
isError - true if the tool call ended in an error
content - the list of content items (must not be null)
structuredContent - the optional structured result of the tool call
_meta - the optional metadata
public record ToolResponse(boolean isError, List<? extends Content> content, Object structuredContent, Map<MetaKey,Object> _meta) extends Record
Response to a tools/call request from the client.

  • Constructor Details

    • ToolResponse

      public ToolResponse(boolean isError, List<? extends Content> content, Map<MetaKey,Object> _meta)

    • ToolResponse

      public ToolResponse(boolean isError, List<? extends Content> content)

    • ToolResponse

      public ToolResponse(boolean isError, List<? extends Content> content, Object structuredContent, Map<MetaKey,Object> _meta)
      Creates an instance of a ToolResponse record class.
      Parameters:
      isError - the value for the isError record component
      content - the value for the content record component
      structuredContent - the value for the structuredContent record component
      _meta - the value for the _meta record component

  • Method Details

    • success

      @SafeVarargs public static <C extends Content> ToolResponse success(C... content)
      Type Parameters:
      C - the content type
      Parameters:
      content - the content
      Returns:
      a successful response with the specified content items

    • success

      public static <C extends Content> ToolResponse success(List<C> content)
      Type Parameters:
      C - the content type
      Parameters:
      content - the content
      Returns:
      a successful response with the specified content items

    • error

      public static ToolResponse error(String message)
      Parameters:
      message - the error message
      Returns:
      an unsuccessful response with single text content item

    • success

      public static ToolResponse success(String message)
      Parameters:
      message - the message to include as text content in the response
      Returns:
      a successful response with single text content item

    • structuredError

      public static ToolResponse structuredError(Object structuredContent)
      Parameters:
      structuredContent - the structured content to include in the response
      Returns:
      an unsuccessful response with structured content

    • structuredSuccess

      public static ToolResponse structuredSuccess(String message, Object structuredContent)
      Parameters:
      message - a message, returned as unstructured text content
      structuredContent - the structured content
      Returns:
      a successful response with structured content

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • isError

      public boolean isError()
      Returns the value of the isError record component.
      Returns:
      the value of the isError record component

    • content

      public List<? extends Content> content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component

    • structuredContent

      public Object structuredContent()
      Returns the value of the structuredContent record component.
      Returns:
      the value of the structuredContent record component

    • _meta

      public Map<MetaKey,Object> _meta()
      Returns the value of the _meta record component.
      Returns:
      the value of the _meta record component