Tool extension type
Definition for a tool the client can call.
- on
- Implemented types
Constructors
-
Tool({required String name, String? title, String? description, required ObjectSchema inputSchema, ObjectSchema? outputSchema, ToolAnnotations? annotations, Meta? meta, List<
Icon> ? icons}) -
factory
-
Tool.fromMap(Map<
String, Object?> _value)
Properties
- description → String?
-
A human-readable description of the tool.
no setter
-
icons
→ List<
Icon> ? -
Optional set of sized icons that the client can display in a user
interface.
no setter
- inputSchema → ObjectSchema
-
A JSON ObjectSchema object defining the expected parameters for the
tool.
no setter
- name → String
-
Intended for programmatic or logical use, but used as a display name in
past specs for fallback (if title isn't present).
no setterinherited
- outputSchema → ObjectSchema?
-
An optional JSON ObjectSchema object defining the expected schema of the
tool output.
no setter
- title → String?
-
A short title for this object.
no setterinherited
- toolAnnotations → ToolAnnotations?
-
Optional additional tool information.
no setter