ToolAnnotations extension type
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.
Constructors
- ToolAnnotations.new({bool? destructiveHint, bool? idempotentHint, bool? openWorldHint, bool? readOnlyHint, String? title})
-
factory
-
ToolAnnotations.fromMap(Map<
String, Object?> _value)
Properties
- destructiveHint → bool?
-
If true, the tool may perform destructive updates to its environment.
no setter
- idempotentHint → bool?
-
If true, calling the tool repeatedly with the same arguments will have no
additional effect on the its environment.
no setter
- openWorldHint → bool?
-
If true, this tool may interact with an "open world" of external entities.
no setter
- readOnlyHint → bool?
-
If true, the tool does not modify its environment.
no setter
- title → String?
-
A human-readable title for the tool.
no setter