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

ToolAnnotations

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

Additional properties describing a Tool to clients.

NOTE: all properties in ToolAnnotations are hints. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like title).

Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers.

Constructors

ToolAnnotations

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

Properties

destructiveHint

val destructiveHint: Boolean? = true

If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

idempotentHint

val idempotentHint: Boolean? = false

If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.

openWorldHint

val openWorldHint: Boolean? = true

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.

readOnlyHint

val readOnlyHint: Boolean? = false

If true, the tool does not modify its environment.

title

val title: String?

A human-readable title for the tool.