Class McpToolAnnotations

java.lang.Object

com.soklet.McpToolAnnotations

@ThreadSafe
public final class McpToolAnnotations
extends Object

Immutable MCP client hints describing a tool's behavior.

Hints are advisory and must never be used as authorization or safety controls. Each boolean preserves the difference between an omitted hint and an explicitly supplied false value.

Author:

Mark Allen

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull McpToolAnnotations.Builder	builder()
boolean	equals(@Nullable Object other)
@NonNull Optional<@NonNull Boolean>	getDestructiveHint()
@NonNull Optional<@NonNull Boolean>	getIdempotentHint()
@NonNull Optional<@NonNull Boolean>	getOpenWorldHint()
@NonNull Optional<@NonNull Boolean>	getReadOnlyHint()
@NonNull Optional<@NonNull String>	getTitle()
int	hashCode()

Methods inherited from class Object

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

Method Details

builder

public static @NonNull McpToolAnnotations.Builder builder()

Returns:

an empty tool-annotation builder

getTitle

public @NonNull Optional<@NonNull String> getTitle()

Returns:

human-readable title hint, if supplied

getReadOnlyHint

public @NonNull Optional<@NonNull Boolean> getReadOnlyHint()

Returns:

read-only hint, preserving omission

getDestructiveHint

public @NonNull Optional<@NonNull Boolean> getDestructiveHint()

Returns:

destructive hint, preserving omission

getIdempotentHint

public @NonNull Optional<@NonNull Boolean> getIdempotentHint()

Returns:

idempotent hint, preserving omission

getOpenWorldHint

public @NonNull Optional<@NonNull Boolean> getOpenWorldHint()

Returns:

open-world interaction hint, preserving omission

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether every tool hint is structurally equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural tool-hint hash code