Prompt class - mcp_host library

Constructors

Prompt({List<PromptArgument>? arguments, String? description, required String name, Map<String, Object?>? meta, String? title, List<McpIcon>? icons, Map<String, Object?>? extra})
Prompt.fromJson(Map<String, Object?> json): Wraps json as received; nothing is dropped.

arguments → List<PromptArgument>?: A list of arguments to use for templating the prompt.
no setter
description → String?: An optional description of what this prompt provides
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
icons → List<McpIcon>?: Optional set of sized icons that the client can display in a user interface.
no setter
meta → Map<String, Object?>?: no setter
name → String: Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).
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
title → String?: Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.
no setter

$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({List<PromptArgument>? arguments, String? description, String? name, Map<String, Object?>? meta, String? title, List<McpIcon>? icons}) → Prompt: 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

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