Class ToolAnnotations
What a call of a tool does, as hints a client decides by whether to ask its user before it calls it.
public sealed record ToolAnnotations : IEquatable<ToolAnnotations>
- Inheritance
-
ToolAnnotations
- Implements
- Inherited Members
Remarks
The hints describe the tool; they guard nothing. A client that applies a tool's edits applies them only once its user approves them.
Properties
DestructiveHint
Whether a tool that changes something may change what is there already, rather than only add to it: an edit of a document.
public bool DestructiveHint { get; init; }
Property Value
IdempotentHint
Whether a second call with the same arguments does nothing more than the first.
public bool IdempotentHint { get; init; }
Property Value
OpenWorldHint
Whether the tool reaches beyond the workspace: the network, another program. The language server's tools do not.
public bool OpenWorldHint { get; init; }
Property Value
ReadOnlyHint
Whether the tool changes nothing: it only reads the workspace.
public bool ReadOnlyHint { get; init; }