Struct CreateMessageRequest

pub struct CreateMessageRequest {
    pub params: CreateMessageRequestParams,
    /* private fields */
}

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.

JSON schema

{
 "description": "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.",
 "type": "object",
 "required": [
   "method",
   "params"
 ],
 "properties": {
   "method": {
     "type": "string",
     "const": "sampling/createMessage"
   },
   "params": {
     "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

params: CreateMessageRequestParams

Implementations

impl CreateMessageRequest

pub fn new(params: CreateMessageRequestParams) -> Self

pub fn method(&self) -> &String

pub fn method_name() -> String

Trait Implementations

impl Clone for CreateMessageRequest

fn clone(&self) -> CreateMessageRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateMessageRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateMessageRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateMessageRequest> for MessageFromServer

fn from(value: CreateMessageRequest) -> Self

Converts to this type from the input type.

impl From<CreateMessageRequest> for RequestFromServer

fn from(value: CreateMessageRequest) -> Self

Converts to this type from the input type.

impl From<CreateMessageRequest> for ServerRequest

fn from(value: CreateMessageRequest) -> Self

Converts to this type from the input type.

impl FromMessage<CreateMessageRequest> for ServerMessage

fn from_message( message: CreateMessageRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

impl Serialize for CreateMessageRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessage<ServerMessage> for CreateMessageRequest

fn to_message( self, request_id: Option<RequestId>, ) -> Result<ServerMessage, RpcError>

impl TryFrom<RequestFromServer> for CreateMessageRequest

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from(value: RequestFromServer) -> Result<Self, Self::Error>

Performs the conversion.