Skip to main content

CreateMessageRequestParams

Struct CreateMessageRequestParams 

Source
pub struct CreateMessageRequestParams {
    pub messages: Vec<SamplingMessage>,
    pub model_preferences: Option<ModelPreferences>,
    pub system_prompt: Option<String>,
    pub include_context: Option<String>,
    pub temperature: Option<f64>,
    pub max_tokens: u32,
    pub stop_sequences: Option<Vec<String>>,
    pub metadata: Option<HashMap<String, Value>>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: Option<ToolChoice>,
}
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Expand description

Parameters for sampling/createMessage request (per MCP spec).

Deprecated per SEP-2577 — see module-level docs.

include_context value note: "thisServer" and "allServers" are soft-deprecated per SEP-2596 and conditional on ClientCapabilities.sampling.context. Omit the field or use "none".

Fields§

§messages: Vec<SamplingMessage>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Messages for context

§model_preferences: Option<ModelPreferences>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional model preferences

§system_prompt: Option<String>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional system prompt

§include_context: Option<String>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional include context

§temperature: Option<f64>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional temperature

§max_tokens: u32
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Maximum tokens (required field)

§stop_sequences: Option<Vec<String>>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional stop sequences

§metadata: Option<HashMap<String, Value>>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional metadata to pass through to the LLM provider.

Schema: metadata?: JSONObject — same HashMap<String, Value> convention this crate uses for other JSONObject fields (e.g. ClientCapabilities.experimental).

§tools: Option<Vec<Tool>>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional tools the LLM can use during sampling.

§tool_choice: Option<ToolChoice>
👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: integrate directly with LLM provider APIs. Earliest removal: first release on/after 2027-07-28.

Optional tool choice configuration.

Implementations§

Source§

impl CreateMessageRequestParams

Source

pub fn new( messages: Vec<SamplingMessage>, max_tokens: u32, ) -> CreateMessageRequestParams

Source

pub fn with_tools(self, tools: Vec<Tool>) -> CreateMessageRequestParams

Source

pub fn with_tool_choice( self, tool_choice: ToolChoice, ) -> CreateMessageRequestParams

Source

pub fn with_model_preferences( self, preferences: ModelPreferences, ) -> CreateMessageRequestParams

Source

pub fn with_system_prompt( self, prompt: impl Into<String>, ) -> CreateMessageRequestParams

Source

pub fn with_temperature(self, temperature: f64) -> CreateMessageRequestParams

Source

pub fn with_stop_sequences( self, sequences: Vec<String>, ) -> CreateMessageRequestParams

Source

pub fn validate_message_shape(&self) -> Result<(), String>

Sampling message-shape MUSTs:

  • A user-role message whose content contains a ToolResult block MUST contain ONLY ToolResult blocks (no mixing with text/image/etc.).
  • Every assistant-role message containing a ToolUse block MUST be immediately followed by a user-role message consisting entirely of ToolResult blocks whose tool_use_ids match the preceding ToolUse ids.

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<(), Error>

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

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

Source§

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

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

impl HasCreateMessageRequestParams for CreateMessageRequestParams

Source§

fn messages(&self) -> &Vec<SamplingMessage>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn model_preferences(&self) -> Option<&ModelPreferences>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn system_prompt(&self) -> Option<&String>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn include_context(&self) -> Option<&String>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn temperature(&self) -> Option<&f64>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn max_tokens(&self) -> u32

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn stop_sequences(&self) -> Option<&Vec<String>>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

fn metadata(&self) -> Option<&HashMap<String, Value>>

👎Deprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28) with the Sampling surface. Earliest removal: first release on/after 2027-07-28.

Source§

impl Params for CreateMessageRequestParams

Source§

impl SerdeParamExtractor<CreateMessageRequestParams> for CreateMessageRequestParams

Source§

impl Serialize for CreateMessageRequestParams

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more