Class McpToolOutput

java.lang.Object

com.soklet.McpToolOutput

All Implemented Interfaces:

McpCompletePayload

@ThreadSafe
public final class McpToolOutput
extends Object
implements McpCompletePayload

Immutable output of one completed MCP tool call.

For either 2025 protocol revision, structured content must be a JSON object and any declared output schema must have object type. The modern revision permits other JSON shapes. Raw/advanced handlers share one output type, so applications must select a representable shape before performing side effects. The legacy adapter does not silently wrap or discard a non-object structured value. June tool resource links omit optional icons; November and modern tool links retain them.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McpToolOutput.Builder	Mutable builder for immutable McpToolOutput.

Method Summary

Modifier and Type	Method	Description
static @NonNull McpToolOutput.Builder	builder()
boolean	equals(@Nullable Object other)
static @NonNull McpToolOutput	fromErrorText(@NonNull String text)	Creates error prose output.
static @NonNull McpToolOutput	fromStructuredContent(@NonNull McpJsonValue structuredContent)	Creates successful structured output.
static @NonNull McpToolOutput	fromText(@NonNull String text)	Creates successful prose output.
@NonNull List<@NonNull McpContentBlock>	getContent()
@NonNull Optional<@NonNull McpJsonValue>	getStructuredContent()
int	hashCode()
@NonNull Boolean	isError()
@NonNull McpToolOutput.Builder	toBuilder()	Returns a builder initialized with every field of this output.

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static @NonNull McpToolOutput.Builder builder()

Returns:

an empty tool-output builder

fromText

public static @NonNull McpToolOutput fromText(@NonNull String text)

Creates successful prose output.

Parameters:

text - prose text

Returns:

tool output containing one text block

fromStructuredContent

public static @NonNull McpToolOutput fromStructuredContent(@NonNull McpJsonValue structuredContent)

Creates successful structured output.

Parameters:

structuredContent - structured JSON value

Returns:

tool output carrying structured content

fromErrorText

public static @NonNull McpToolOutput fromErrorText(@NonNull String text)

Creates error prose output.

Parameters:

text - safe client-visible error text

Returns:

error tool output containing one text block

getContent

public @NonNull List<@NonNull McpContentBlock> getContent()

Returns:

immutable content blocks in insertion order

getStructuredContent

public @NonNull Optional<@NonNull McpJsonValue> getStructuredContent()

Returns:

structured JSON content, if supplied

isError

public @NonNull Boolean isError()

Returns:

whether the tool reported an application-level error

toBuilder

public @NonNull McpToolOutput.Builder toBuilder()

Returns a builder initialized with every field of this output.

Content blocks retain their insertion order, structured content is copied when present, and the application-level error state is preserved. This is the preferred starting point for a sanitizer that changes only selected fields while retaining all other tool output.

Returns:

field-preserving builder initialized from this output

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether every tool-output property is structurally equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural tool-output hash code