Class ToolDescriptor
What a tool is, as an assistant reads it: its name, what it does, the arguments it takes and what it answers.
public sealed record ToolDescriptor : IEquatable<ToolDescriptor>
- Inheritance
-
ToolDescriptor
- Implements
- Inherited Members
Properties
Annotations
What a call does to the workspace: the hints a client decides by whether to ask its user before a call.
public ToolAnnotations Annotations { get; init; }
Property Value
Description
What the tool does and when to call it, in the language of the client's user interface. Positions in it, in its arguments and in its results are 1-based lines and columns.
public string Description { get; init; }
Property Value
InputSchema
The JSON Schema of the arguments a call gives (Arguments): an object schema.
public JsonObject InputSchema { get; init; }
Property Value
Name
The name a call gives (Name): letters, digits, _ and -, at most 64 characters, the same in every language.
public string Name { get; init; }
Property Value
OutputSchema
The JSON Schema of the structured result of a call (StructuredContent); null for a tool that answers with text alone.
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public JsonObject? OutputSchema { get; init; }
Property Value
Title
A short name for a person to read, in the language of the client's user interface; null when the tool has none.
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Title { get; init; }