Package dev.tachyonmcp.api.server.domain

Interface ToolAnnotations

@Immutable
public interface ToolAnnotations

Hints about tool behaviour that clients may use for safety or UX decisions.

All fields are optional — when null the client should make no assumptions about the corresponding property. readOnlyHint marks tools that do not modify state, destructiveHint warns about irreversible changes, idempotentHint indicates safe retries, and openWorldHint signals that the tool may reach outside the MCP ecosystem.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ToolAnnotations.Builder

Method Summary

Modifier and Type	Method	Description
static ToolAnnotations.Builder	builder()
@Nullable Boolean	destructiveHint()
@Nullable Boolean	idempotentHint()
static ToolAnnotations	of(@Nullable String title, @Nullable Boolean readOnlyHint, @Nullable Boolean destructiveHint, @Nullable Boolean idempotentHint, @Nullable Boolean openWorldHint)
@Nullable Boolean	openWorldHint()
@Nullable Boolean	readOnlyHint()
@Nullable String	title()

Method Details

title

@Nullable String title()

readOnlyHint

@Nullable Boolean readOnlyHint()

destructiveHint

@Nullable Boolean destructiveHint()

idempotentHint

@Nullable Boolean idempotentHint()

openWorldHint

@Nullable Boolean openWorldHint()

builder

static ToolAnnotations.Builder builder()

of

static ToolAnnotations of(@Nullable String title,
 @Nullable Boolean readOnlyHint,
 @Nullable Boolean destructiveHint,
 @Nullable Boolean idempotentHint,
 @Nullable Boolean openWorldHint)