Skip to main content

CreateMessageRequestParams

Struct CreateMessageRequestParams 

Source
pub struct CreateMessageRequestParams {
    pub include_context: Option<IncludeContext>,
    pub max_tokens: i64,
    pub messages: Vec<SamplingMessage>,
    pub metadata: Option<JsonObject>,
    pub model_preferences: Option<ModelPreferences>,
    pub stop_sequences: Vec<String>,
    pub system_prompt: Option<String>,
    pub temperature: Option<f64>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Vec<Tool>,
}
Expand description

Latest MCP Protocol 2026_07_28 Parameters for a sampling/createMessage request.

JSON schema
{
 "description": "Parameters for a sampling/createMessage request.",
 "type": "object",
 "required": [
   "maxTokens",
   "messages"
 ],
 "properties": {
   "includeContext": {
     "description": "A request to include context from one or more MCP servers (including the caller), to be attached to the prompt.\nThe client MAY ignore this request.\n\nDefault is \"none\". The values \"thisServer\" and \"allServers\" are deprecated (SEP-2596): servers SHOULD\nomit this field or use \"none\", and SHOULD only use the deprecated values if the client declares\n{@link ClientCapabilities.sampling.context}.",
     "type": "string",
     "enum": [
       "allServers",
       "none",
       "thisServer"
     ]
   },
   "maxTokens": {
     "description": "The requested maximum number of tokens to sample (to prevent runaway completions).\n\nThe client MAY choose to sample fewer tokens than the requested maximum.",
     "type": "integer"
   },
   "messages": {
     "type": "array",
     "items": {
       "$ref": "#/$defs/SamplingMessage"
     }
   },
   "metadata": {
     "description": "Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific.",
     "$ref": "#/$defs/JSONObject"
   },
   "modelPreferences": {
     "description": "The server's preferences for which model to select. The client MAY ignore these preferences.",
     "$ref": "#/$defs/ModelPreferences"
   },
   "stopSequences": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "systemPrompt": {
     "description": "An optional system prompt the server wants to use for sampling. The client MAY modify or omit this prompt.",
     "type": "string"
   },
   "temperature": {
     "type": "number"
   },
   "toolChoice": {
     "description": "Controls how the model uses tools.\nThe client MUST return an error if this field is provided but {@link ClientCapabilities.sampling.tools} is not declared.\nDefault is { mode: \"auto\" }.",
     "$ref": "#/$defs/ToolChoice"
   },
   "tools": {
     "description": "Tools that the model may use during generation.\nThe client MUST return an error if this field is provided but {@link ClientCapabilities.sampling.tools} is not declared.",
     "type": "array",
     "items": {
       "$ref": "#/$defs/Tool"
     }
   }
 }
}

Fields§

§include_context: Option<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. Default is “none”. The values “thisServer” and “allServers” are deprecated (SEP-2596): servers SHOULD omit this field or use “none”, and SHOULD only use the deprecated values if the client declares {@link ClientCapabilities.sampling.context}.

§max_tokens: i64

The requested maximum number of tokens to sample (to prevent runaway completions). The client MAY choose to sample fewer tokens than the requested maximum.

§messages: Vec<SamplingMessage>§metadata: Option<JsonObject>

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

§model_preferences: Option<ModelPreferences>

The server’s preferences for which model to select. The client MAY ignore these preferences.

§stop_sequences: Vec<String>§system_prompt: Option<String>

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

§temperature: Option<f64>§tool_choice: Option<ToolChoice>

Controls how the model uses tools. The client MUST return an error if this field is provided but {@link ClientCapabilities.sampling.tools} is not declared. Default is { mode: “auto” }.

§tools: Vec<Tool>

Tools that the model may use during generation. The client MUST return an error if this field is provided but {@link ClientCapabilities.sampling.tools} is not declared.

Trait Implementations§

Source§

impl Clone for CreateMessageRequestParams

Source§

fn clone(&self) -> CreateMessageRequestParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateMessageRequestParams

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CreateMessageRequestParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CreateMessageRequestParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.