kotlin-sdk-core/io.modelcontextprotocol.kotlin.sdk.types/ToolAnnotations

ToolAnnotations

data class ToolAnnotations(val title: String? = null, val readOnlyHint: Boolean? = null, val destructiveHint: Boolean? = null, val idempotentHint: Boolean? = null, val openWorldHint: Boolean? = null)(source)

Additional properties describing a Tool to clients.

IMPORTANT: All properties in ToolAnnotations are hints. They are NOT guaranteed to provide a faithful description of tool behavior (including descriptive properties like title).

Security warning: Clients should NEVER make tool use decisions based on ToolAnnotations received from untrusted servers.

Constructors

ToolAnnotations

constructor(title: String? = null, readOnlyHint: Boolean? = null, destructiveHint: Boolean? = null, idempotentHint: Boolean? = null, openWorldHint: Boolean? = null)

Properties

destructiveHint

val destructiveHint: Boolean?

If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. This property is meaningful only when readOnlyHint == false. Default: true

idempotentHint

val idempotentHint: Boolean?

If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. This property is meaningful only when readOnlyHint == false. Default: false

openWorldHint

val openWorldHint: Boolean?

If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true

readOnlyHint

val readOnlyHint: Boolean?

If true, the tool does not modify its environment. If false, the tool may perform modifications. Default: false

title

val title: String?

A human-readable title for the tool. Takes precedence over Tool.title and Tool.name for display purposes.