CallToolResult class final

The result returned by the server for a CallToolRequesttools/call request.

Revisions: 2024-11-05, 2025-03-26, 2025-06-18, 2025-11-25, 2026-07-28.

Inheritance

Constructors

CallToolResult({ResultMetaObject? meta, required List<ContentBlock> content, bool? isError, Object? structuredContent, String? resultType, Map<String, Object?>? extra})
CallToolResult.fromJson(Map<String, Object?> json)
Wraps json as received; nothing is dropped.

Properties

content → List<ContentBlock>
A list of content objects that represent the unstructured result of the tool call.
no setter
extra → Map<String, Object?>
Keys outside the schema (newer revisions, extensions, applications).
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isError → bool?
Whether the tool call ended in an error.
no setter
meta → ResultMetaObject?
no setter
resultType → String?
Indicates the type of the result, which allows the client to determine how to parse the result object.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaKeys → Set<String>
Property names the schema defines for this type.
no setteroverride
structuredContent → Object?
An optional JSON value that represents the structured result of the tool call.
no setter

Methods

$optional<T>(String key, T? read(Object? value, String path)) → T?
Optional property key, converted by read; null when absent or null.
inherited
$required<T>(String key, T read(Object? value, String path)) → T
Required property key, converted by read.
inherited
check() → List<String>
Reads every property this type defines and returns what could not be read (missing required properties, wrong types), nested types included. Empty = the JSON matches the schema's shape for this type.
override
copyWith({ResultMetaObject? meta, List<ContentBlock>? content, bool? isError, Object? structuredContent, String? resultType}) → CallToolResult
A copy with the given properties replaced; everything else, unknown keys included, is kept.
has(String key) → bool
Whether key is present (a null value counts as present).
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
The JSON form of this value.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
Equal when the JSON is equal; key order does not matter.
inherited
operator [](String key) → Object?
The raw JSON value of key.
inherited

Constants

keys → const Set<String>