ToolSchema class

Execution-related properties for a Tool. JSON Schema (2020-12) object used for a tool's Tool.inputSchema or Tool.outputSchema.

Exposes properties/required/type as typed convenience accessors, but preserves any other JSON Schema keyword (oneOf, $ref, items, $defs, etc.) losslessly via additionalData.

Inheritance

Constructors

ToolSchema({String? $schema, Map<String, Object?>? properties, List<String>? required, String type = 'object', Map<String, Object?>? additionalData})
ToolSchema.toMCP(Map<String, Object?> map)
factory

Properties

$schema String?
Optional $schema URI. Defaults to JSON Schema 2020-12 when absent.
getter/setter pair
additionalData Map<String, Object?>?
Any other JSON Schema keyword not covered by a typed field above, preserved losslessly on round-trip.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
properties Map<String, Object?>?
Property definitions.
getter/setter pair
required List<String>?
Required property names.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
type String
Root type; always "object" for tool schemas.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() Map<String, Object?>
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited