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

Record Class McpSchema.CallToolResult

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.CallToolResult
Record Components:
content - A list of content items representing the tool's output. Each item can be text, an image, or an embedded resource.
isError - If true, indicates that the tool execution failed and the content contains error information. If false or absent, indicates successful execution.
structuredContent - An optional JSON object that represents the structured result of the tool call.
meta - See specification for notes on _meta usage
All Implemented Interfaces:
McpSchema.Result
Enclosing class:
McpSchema
public static record McpSchema.CallToolResult(List<McpSchema.Content> content, Boolean isError, Map<String,Object> structuredContent, Map<String,Object> meta) extends Record implements McpSchema.Result
The server's response to a tools/call request from the client.

  • Constructor Details

    • CallToolResult

      public CallToolResult(List<McpSchema.Content> content, Boolean isError)

    • CallToolResult

      public CallToolResult(List<McpSchema.Content> content, Boolean isError, Map<String,Object> structuredContent)

    • CallToolResult

      public CallToolResult(String content, Boolean isError)
      Creates a new instance of McpSchema.CallToolResult with a string containing the tool result.
      Parameters:
      content - The content of the tool result. This will be mapped to a one-sized list with a McpSchema.TextContent element.
      isError - If true, indicates that the tool execution failed and the content contains error information. If false or absent, indicates successful execution.

    • CallToolResult

      public CallToolResult(List<McpSchema.Content> content, Boolean isError, Map<String,Object> structuredContent, Map<String,Object> meta)
      Creates an instance of a CallToolResult record class.
      Parameters:
      content - the value for the content record component
      isError - the value for the isError record component
      structuredContent - the value for the structuredContent record component
      meta - the value for the meta record component

  • Method Details

    • builder

      public static McpSchema.CallToolResult.Builder builder()
      Creates a builder for McpSchema.CallToolResult.
      Returns:
      a new builder instance

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

    • content

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

    • isError

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

    • structuredContent

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

    • meta

      public Map<String,Object> meta()
      Returns the value of the meta record component.
      Specified by:
      meta in interface McpSchema.Result
      Returns:
      the value of the meta record component