Struct CreateMessageRequestParams

pub struct CreateMessageRequestParams {
    pub include_context: Option<CreateMessageRequestParamsIncludeContext>,
    pub max_tokens: i64,
    pub messages: Vec<SamplingMessage>,
    pub metadata: Option<Map<String, Value>>,
    pub model_preferences: Option<ModelPreferences>,
    pub stop_sequences: Vec<String>,
    pub system_prompt: Option<String>,
    pub temperature: Option<f64>,
}

CreateMessageRequestParams

JSON schema

{
 "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. The client MAY ignore this request.",
     "type": "string",
     "enum": [
       "allServers",
       "none",
       "thisServer"
     ]
   },
   "maxTokens": {
     "description": "The maximum number of tokens to sample, as requested by the server. The client MAY choose to sample fewer tokens than requested.",
     "type": "integer"
   },
   "messages": {
     "type": "array",
     "items": {
       "$ref": "#/definitions/SamplingMessage"
     }
   },
   "metadata": {
     "description": "Optional metadata to pass through to the LLM provider. The format of this metadata is provider-specific.",
     "type": "object",
     "additionalProperties": true
   },
   "modelPreferences": {
     "description": "The server's preferences for which model to select. The client MAY ignore these preferences.",
     "$ref": "#/definitions/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"
   }
 }
}

Fields

include_context: Option<CreateMessageRequestParamsIncludeContext>

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.

max_tokens: i64

The maximum number of tokens to sample, as requested by the server. The client MAY choose to sample fewer tokens than requested.

messages: Vec<SamplingMessage>

metadata: Option<Map<String, Value>>

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>

Trait Implementations

impl Clone for CreateMessageRequestParams

fn clone(&self) -> CreateMessageRequestParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateMessageRequestParams

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateMessageRequestParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.