Skip to main content

Interface: ToolAnnotations

Interface: ToolAnnotations

Properties

destructive?

optional destructive: boolean;

Deprecated

Prefer effect with value "destructive". Retained so existing annotations continue to force the approval gate, and so MCP-style consumers that only read destructive still see the hint.


effect?

optional effect: ToolEffect;

Preferred semantic label. When set, drives both the approval gate (fires for write/update/destructive) and the approval-card styling.


idempotent?

optional idempotent: boolean;

readOnly?

optional readOnly: boolean;

Deprecated

Prefer effect. Retained for backward compatibility with tools authored against the original flags and for MCP interop.


requiresUserContext?

optional requiresUserContext: boolean;

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs