Interface: ToolAnnotations

Defined in: packages/core/src/domain/ToolAnnotations.ts:22

MCP Tool Annotations — behavioral hints for LLMs.

These annotations provide metadata that helps LLMs make safer decisions about when and how to invoke a tool.

Example

import { createToolAnnotations } from '@vinkius-core/mcp-fusion';

const annotations = createToolAnnotations({
    title: 'File Reader',
    readOnlyHint: true,
    destructiveHint: false,
    idempotentHint: true,
});

See

• Tool for usage on tool instances
• createToolAnnotations for the factory function

Properties

destructiveHint?

readonly optional destructiveHint: boolean;

Defined in: packages/core/src/domain/ToolAnnotations.ts:28

Hint that this tool may cause irreversible changes

---

idempotentHint?

readonly optional idempotentHint: boolean;

Defined in: packages/core/src/domain/ToolAnnotations.ts:30

Hint that calling this tool multiple times has the same effect

---

openWorldHint?

readonly optional openWorldHint: boolean;

Defined in: packages/core/src/domain/ToolAnnotations.ts:32

Hint that the tool may access external/uncontrolled systems

---

readOnlyHint?

readonly optional readOnlyHint: boolean;

Defined in: packages/core/src/domain/ToolAnnotations.ts:26

Hint that this tool only reads data (no side effects)

---

returnDirect?

readonly optional returnDirect: boolean;

Defined in: packages/core/src/domain/ToolAnnotations.ts:34

Hint that the response should be returned directly to the user

---

title?

readonly optional title: string;

Defined in: packages/core/src/domain/ToolAnnotations.ts:24

Human-readable display title for the tool