Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.CreateMessageRequest

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.CreateMessageRequest

Record Components:

messages - The conversation messages to send to the LLM

modelPreferences - The server's preferences for which model to select. The client MAY ignore these preferences

systemPrompt - An optional system prompt the server wants to use for sampling. The client MAY modify or omit this prompt

includeContext - A request to include context from one or more MCP servers (including the caller), to be attached to the prompt. The client MAY ignore this request

temperature - Optional temperature parameter 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

stopSequences - Optional stop sequences for sampling

metadata - Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Request

Enclosing class:

McpSchema

public static record McpSchema.CreateMessageRequest(List<McpSchema.SamplingMessage> messages, McpSchema.ModelPreferences modelPreferences, String systemPrompt, McpSchema.CreateMessageRequest.ContextInclusionStrategy includeContext, Double temperature, int maxTokens, List<String> stopSequences, Map<String,Object> metadata, Map<String,Object> meta)
extends Record
implements McpSchema.Request

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.CreateMessageRequest.Builder
static enum	McpSchema.CreateMessageRequest.ContextInclusionStrategy

Constructor Summary

Constructors

Constructor	Description
CreateMessageRequest(List<McpSchema.SamplingMessage> messages, McpSchema.ModelPreferences modelPreferences, String systemPrompt, McpSchema.CreateMessageRequest.ContextInclusionStrategy includeContext, Double temperature, int maxTokens, List<String> stopSequences, Map<String,Object> metadata)
CreateMessageRequest(List<McpSchema.SamplingMessage> messages, McpSchema.ModelPreferences modelPreferences, String systemPrompt, McpSchema.CreateMessageRequest.ContextInclusionStrategy includeContext, Double temperature, int maxTokens, List<String> stopSequences, Map<String,Object> metadata, Map<String,Object> meta)	Creates an instance of a CreateMessageRequest record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.CreateMessageRequest.Builder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
McpSchema.CreateMessageRequest.ContextInclusionStrategy	includeContext()	Returns the value of the includeContext record component.
int	maxTokens()	Returns the value of the maxTokens record component.
List<McpSchema.SamplingMessage>	messages()	Returns the value of the messages record component.
Map<String,Object>	meta()	Returns the value of the meta record component.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
McpSchema.ModelPreferences	modelPreferences()	Returns the value of the modelPreferences record component.
List<String>	stopSequences()	Returns the value of the stopSequences record component.
String	systemPrompt()	Returns the value of the systemPrompt record component.
Double	temperature()	Returns the value of the temperature record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.modelcontextprotocol.spec.McpSchema.Request

progressToken

Constructor Details

CreateMessageRequest

public CreateMessageRequest(List<McpSchema.SamplingMessage> messages,
 McpSchema.ModelPreferences modelPreferences,
 String systemPrompt,
 McpSchema.CreateMessageRequest.ContextInclusionStrategy includeContext,
 Double temperature,
 int maxTokens,
 List<String> stopSequences,
 Map<String,Object> metadata)

CreateMessageRequest

public CreateMessageRequest(List<McpSchema.SamplingMessage> messages,
 McpSchema.ModelPreferences modelPreferences,
 String systemPrompt,
 McpSchema.CreateMessageRequest.ContextInclusionStrategy includeContext,
 Double temperature,
 int maxTokens,
 List<String> stopSequences,
 Map<String,Object> metadata,
 Map<String,Object> meta)

Creates an instance of a CreateMessageRequest record class.

Parameters:

messages - the value for the messages record component

modelPreferences - the value for the modelPreferences record component

systemPrompt - the value for the systemPrompt record component

includeContext - the value for the includeContext record component

temperature - the value for the temperature record component

maxTokens - the value for the maxTokens record component

stopSequences - the value for the stopSequences record component

metadata - the value for the metadata record component

meta - the value for the meta record component

Method Details

builder

public static McpSchema.CreateMessageRequest.Builder builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

messages

public List<McpSchema.SamplingMessage> messages()

Returns the value of the messages record component.

Returns:

the value of the messages record component

modelPreferences

public McpSchema.ModelPreferences modelPreferences()

Returns the value of the modelPreferences record component.

Returns:

the value of the modelPreferences record component

systemPrompt

public String systemPrompt()

Returns the value of the systemPrompt record component.

Returns:

the value of the systemPrompt record component

includeContext

public McpSchema.CreateMessageRequest.ContextInclusionStrategy includeContext()

Returns the value of the includeContext record component.

Returns:

the value of the includeContext record component

temperature

public Double temperature()

Returns the value of the temperature record component.

Returns:

the value of the temperature record component

maxTokens

public int maxTokens()

Returns the value of the maxTokens record component.

Returns:

the value of the maxTokens record component

stopSequences

public List<String> stopSequences()

Returns the value of the stopSequences record component.

Returns:

the value of the stopSequences record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Request

Returns:

the value of the meta record component