Skip to main content

CreateMessageRequestParams

mcp_utils::model

Struct CreateMessageRequestParams 

Source 
#[non_exhaustive]
pub struct CreateMessageRequestParams {
    pub meta: Option<RequestMetaObject>,
    pub messages: Vec<SamplingMessage>,
    pub model_preferences: Option<ModelPreferences>,
    pub system_prompt: Option<String>,
    pub include_context: Option<ContextInclusion>,
    pub temperature: Option<f32>,
    pub max_tokens: u32,
    pub stop_sequences: Option<Vec<String>>,
    pub metadata: Option<Value>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: Option<ToolChoice>,
}
👎Deprecated since 2.0.0:

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Expand description

Parameters for creating a message through LLM sampling.

This structure contains all the necessary information for a client to generate an LLM response, including conversation history, model preferences, and generation parameters.

This implements TaskAugmentedRequestParamsMeta as sampling requests can be long-running and may benefit from task-based execution.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§meta: Option<RequestMetaObject>
👎Deprecated since 2.0.0:

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Protocol-level metadata for this request (SEP-1319)

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

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

The conversation history and current messages

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

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Preferences for model selection and behavior

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

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

System prompt to guide the model’s behavior

§include_context: Option<ContextInclusion>
👎Deprecated since 2.0.0:

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

How much context to include from MCP servers

§temperature: Option<f32>
👎Deprecated since 2.0.0:

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Temperature for controlling randomness (0.0 to 1.0)

§max_tokens: u32
👎Deprecated since 2.0.0:

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Maximum number of tokens to generate

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

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Sequences that should stop generation

§metadata: Option<Value>
👎Deprecated since 2.0.0:

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Additional metadata for the request

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

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Tools available for the model to call (SEP-1577)

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

Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577

Tool selection behavior (SEP-1577)

Implementations§

Source§

impl CreateMessageRequestParams

Source

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

Create a new CreateMessageRequestParams with required fields.

Source

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

Set model preferences.

Source

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

Set system prompt.

Source

pub fn with_include_context( self, include_context: ContextInclusion, ) -> CreateMessageRequestParams

Set include context.

Source

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

Set temperature.

Source

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

Set stop sequences.

Source

pub fn with_metadata(self, metadata: Value) -> CreateMessageRequestParams

Set metadata.

Source

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

Set tools.

Source

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

Set tool choice.

Source

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

Validate the sampling request parameters per SEP-1577 spec requirements.

Checks:

  • ToolUse content is only allowed in assistant messages
  • ToolResult content is only allowed in user messages
  • Messages with tool result content MUST NOT contain other content types
  • Every assistant ToolUse must be balanced with a corresponding user ToolResult

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 Default for CreateMessageRequestParams

Source§

fn default() -> CreateMessageRequestParams

Returns the “default value” for a type. 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 JsonSchema for CreateMessageRequestParams

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for CreateMessageRequestParams

Source§

fn eq(&self, other: &CreateMessageRequestParams) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl RequestParamsMeta for CreateMessageRequestParams

Source§

fn meta(&self) -> Option<&RequestMetaObject>

Get a reference to the meta field
Source§

fn meta_mut(&mut self) -> &mut Option<RequestMetaObject>

Get a mutable reference to the meta field
Source§

fn set_meta(&mut self, meta: RequestMetaObject)

Set the meta field
Source§

fn progress_token(&self) -> Option<ProgressToken>

Get the progress token from meta, if present
Source§

fn set_progress_token(&mut self, token: ProgressToken)

Set a progress token in meta
Source§

fn traceparent(&self) -> Option<&str>

Get the W3C traceparent value from meta, if present (SEP-414)
Source§

fn set_traceparent(&mut self, value: &str)

Set the W3C traceparent value in meta (SEP-414)
Source§

fn tracestate(&self) -> Option<&str>

Get the W3C tracestate value from meta, if present (SEP-414)
Source§

fn set_tracestate(&mut self, value: &str)

Set the W3C tracestate value in meta (SEP-414)
Source§

fn baggage(&self) -> Option<&str>

Get the W3C baggage value from meta, if present (SEP-414)
Source§

fn set_baggage(&mut self, value: &str)

Set the W3C baggage value in meta (SEP-414)
Source§

fn meta_or_default(&mut self) -> &mut RequestMetaObject

Get a mutable reference to meta, inserting an empty one if absent.
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
Source§

impl StructuralPartialEq for CreateMessageRequestParams

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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