InputRequiredResult class

A result indicating the original request requires additional client input before the server can produce a final answer.

Sent as the result payload of a CallToolResultResponse, GetPromptResultResponse, or ReadResourceResultResponse when resultType is "input_required". The client should collect inputRequests from the user (and/or echo back requestState) and retry the original request with inputResponses/requestState set.

Inheritance

• Object
• MapMC<String, Object?>
• InputRequiredResult

Implemented types

• CallToolResultOutcome
• GetPromptResultOutcome
• ReadResourceResultOutcome
• Map<A, B>

Available extensions

• MapPath

Constructors

InputRequiredResult({ResultMetaObject? $meta, InputRequests inputRequests, String? requestState, Map<String, Object?>? additionalData})

Creates an InputRequiredResult.

InputRequiredResult.toMCP(Map<String, Object?> map)

Builds an InputRequiredResult from a decoded MCP JSON map.

factory

Properties

$meta ↔ ResultMetaObject?

getter/setter pair

data → Map<String, Object?>

The underlying map data.

final, inherited

entries → Iterable<MapEntry<String, Object?>>

See Map.entries.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

inputRequests ↔ InputRequests

The input the client should collect from the user before retrying.

getter/setter pair

isEmpty → bool

See Map.isEmpty.

no setter, inherited

isNotEmpty → bool

See Map.isNotEmpty.

no setter, inherited

keys → Iterable<String>

See Map.keys.

no setter, inherited

length → int

See Map.length.

no setter, inherited

requestState ↔ String?

Opaque state token to echo back verbatim on retry.

getter/setter pair

resultType → String

Fixed discriminator — always "input_required".

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

values → Iterable<Object?>

See Map.values.

no setter, inherited

Methods

addAll(Map<String, Object?> other) → void

See Map.addAll.

inherited

addEntries(Iterable<MapEntry<String, Object?>> newEntries) → void

See Map.addEntries.

inherited

cast<RK, RV>() → Map<RK, RV>

See Map.cast.

inherited

clear() → void

See Map.clear.

inherited

containsKey(Object? key) → bool

See Map.containsKey.

inherited

containsValue(Object? value) → bool

See Map.containsValue.

inherited

forEach(void action(String key, Object? value)) → void

See Map.forEach.

inherited

map<K2, V2>(MapEntry<K2, V2> convert(String key, Object? value)) → Map<K2, V2>

See Map.map.

inherited

navigation<T>({required String path, required T def}) → T

Available on Map<String, dynamic>, provided by the MapPath extension

Navigates through the map using the provided path and retrieves a value of type T.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putIfAbsent(String key, Object? ifAbsent()) → Object?

See Map.putIfAbsent.

inherited

remove(Object? key) → Object?

See Map.remove.

inherited

removeWhere(bool test(String key, Object? value)) → void

See Map.removeWhere.

inherited

toMap() → Map<String, Object?>

Converts this InputRequiredResult into a JSON-compatible map.

override

toString() → String

A string representation of this object.

inherited

update(String key, Object? update(Object? key), {Object? ifAbsent()?}) → Object?

See Map.update.

inherited

updateAll(Object? update(String key, Object? value)) → void

See Map.updateAll.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](Object? key) → Object?

Delegates to the underlying map's [] operator.

inherited

operator []=(String key, Object? value) → void

Delegates to the underlying map's []= operator.

inherited