Class ToolAnnotations

Namespace

ModelContextProtocol.Protocol.Types

Assembly

ModelContextProtocol.dll

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. See the schema for details There are multiple subtypes of content, depending on the "type" field, these are represented as separate classes.

public class ToolAnnotations

Inheritance

object

ToolAnnotations

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DestructiveHint

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 is false). Default: true.

[JsonPropertyName("destructiveHint")]
public bool? DestructiveHint { get; set; }

Property Value

bool?

IdempotentHint

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 is false). Default: false.

[JsonPropertyName("idempotentHint")]
public bool? IdempotentHint { get; set; }

Property Value

bool?

OpenWorldHint

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.

[JsonPropertyName("openWorldHint")]
public bool? OpenWorldHint { get; set; }

Property Value

bool?

ReadOnlyHint

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

[JsonPropertyName("readOnlyHint")]
public bool? ReadOnlyHint { get; set; }

Property Value

bool?

Title

A human-readable title for the tool.

[JsonPropertyName("title")]
public string? Title { get; set; }

Property Value

string