Class Nexus\Mcp\Schema\Request\CreateMessageRequest

`final`
`readonly`
`extends`	`JsonRpcRequest<array{jsonrpc: '2.0', id: (int\|non-empty-string), method: 'sampling/createMessage', params: array{_meta?: array<string, mixed>, messages: list<template-type<SamplingMessage, Arrayable, 'T'>>, maxTokens: int<0, max>, modelPreferences?: template-type<ModelPreferences, Arrayable, 'T'>, systemPrompt?: non-empty-string, includeContext?: ('allServers'\|'none'\|'thisServer'), temperature?: float, stopSequences?: list<non-empty-string>, metadata?: array<string, mixed>}}>`
`implements`	`ServerRequest`

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.

Nexus\Mcp\Schema\Message\Message implements JsonRpcMessage<TArray, TJson>
- Nexus\Mcp\Schema\Request\Request
  - Nexus\Mcp\Schema\Message\JsonRpcRequest
    - Nexus\Mcp\Schema\Request\CreateMessageRequest implements ServerRequest

Located at Schema/Request/CreateMessageRequest.php

Methods


					
	public

__construct(
	RequestId $id,
	list<SamplingMessage> $messages,
	int<0, max> $maxTokens,
	null|ModelPreferences $modelPreferences = null,
	null|non-empty-string $systemPrompt = null,
	null|'allServers'|'none'|'thisServer' $includeContext = null,
	null|float $temperature = null,
	null|list<non-empty-string> $stopSequences = null,
	null|array<string, mixed> $metadata = null,
	null|array<string, mixed> $meta = null,
)

Parameters

`$id`	JSON-RPC request method.
`$messages`	The messages to be sent to the LLM for sampling.
`$maxTokens`	The maximum number of tokens to sample, as requested by the server. The client MAY choose to sample fewer tokens than requested.
`$modelPreferences`	The server’s preferences for which model to select.
`$systemPrompt`	An optional system prompt the server wants to use for sampling.
`$includeContext`	A request to include context from one or more MCP servers (including the caller), to be attached to the prompt.
`$temperature`	The temperature to use for sampling.
`$stopSequences`	A list of sequences to stop sampling at.
`$metadata`	Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific.
`$meta`	Reserved by MCP to allow clients and servers to attach additional metadata to their interactions.

Overrides

Nexus\Mcp\Schema\Message\JsonRpcRequest::__construct()

Methods inherited from Nexus\Mcp\Schema\Message\JsonRpcRequest
`toArray()`

Methods inherited from Nexus\Mcp\Schema\Request\Request
`jsonSerialize()`

Methods inherited from Nexus\Mcp\Schema\Message\Message
`validateJsonRpc()`

Constants inherited from Nexus\Mcp\Schema\Message\JsonRpcMessage
`JSON_RPC_VERSION`

Properties inherited from Nexus\Mcp\Schema\Message\JsonRpcRequest
`$jsonrpc, $id`

Properties inherited from Nexus\Mcp\Schema\Request\Request
`$method, $params`

Namespaces

Classes

Interfaces

Class Nexus\Mcp\Schema\Request\CreateMessageRequest

Parameters

Overrides