CreateMessageRequest class final

A request from the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it.

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

Inheritance

• Object
• McpObject
• CreateMessageRequest

Implemented types

• ServerRequest
• InputRequest

Constructors

CreateMessageRequest({required CreateMessageRequestParams params, Object? id, Map<String, Object?>? extra})

CreateMessageRequest.fromJson(Map<String, Object?> json)

Wraps json as received; nothing is dropped.

Properties

extra → Map<String, Object?>

Keys outside the schema (newer revisions, extensions, applications).

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → Object?

no setter

jsonrpc → String

no setter

method → String

no setter

params → CreateMessageRequestParams

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemaKeys → Set<String>

Property names the schema defines for this type.

no setter, override

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({CreateMessageRequestParams? params, Object? id}) → CreateMessageRequest

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>