Tool class - mcp_host library

Constructors

Tool({String? description, required Map<String, Object?> inputSchema, required String name, ToolAnnotations? annotations, Map<String, Object?>? meta, Map<String, Object?>? outputSchema, String? title, ToolExecution? execution, List<McpIcon>? icons, Map<String, Object?>? extra})
Tool.fromJson(Map<String, Object?> json): Wraps json as received; nothing is dropped.

annotations → ToolAnnotations?: Optional additional tool information.
no setter
description → String?: A human-readable description of the tool.
no setter
execution → ToolExecution?: Execution-related properties for this tool.
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
inputSchema → Map<String, Object?>: A JSON Schema object defining the expected parameters for the tool.
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
outputSchema → Map<String, Object?>?: An optional JSON Schema object defining the structure of the tool's output returned in the structuredContent field of a CallToolResult. This can be any valid JSON Schema 2020-12.
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({String? description, Map<String, Object?>? inputSchema, String? name, ToolAnnotations? annotations, Map<String, Object?>? meta, Map<String, Object?>? outputSchema, String? title, ToolExecution? execution, List<McpIcon>? icons}) → Tool: 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