ToolAnnotations

import type { ToolAnnotations } from "https://googleapis.deno.dev/v1/connectors:v2.ts";

ToolAnnotations holds annotations for a tool.

interface ToolAnnotations {

destructiveHint?: boolean;

idempotentHint?: boolean;

openWorldHint?: boolean;

readOnlyHint?: boolean;

title?: string;

}

§Properties

destructiveHint?: boolean

[src]

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 read_only_hint == false)

idempotentHint?: boolean

[src]

If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when read_only_hint == false)

openWorldHint?: boolean

[src]

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?: boolean

[src]

If true, the tool does not modify its environment.

title?: string

[src]

A human-readable title for the tool.