Struct ToolChoiceMcp 

pub struct ToolChoiceMcp {
    pub name: Option<String>,
    pub server_label: String,
    pub type_: ToolChoiceMcpType,
}

Use this option to force the model to call a specific tool on a remote MCP server.

JSON schema

{
 "title": "MCP tool",
 "description": "Use this option to force the model to call a specific tool on a remote MCP server.\n",
 "type": "object",
 "required": [
   "server_label",
   "type"
 ],
 "properties": {
   "name": {
     "anyOf": [
       {
         "description": "The name of the tool to call on the server.\n",
         "type": "string"
       }
     ]
   },
   "server_label": {
     "description": "The label of the MCP server to use.\n",
     "type": "string"
   },
   "type": {
     "description": "For MCP tools, the type is always `mcp`.",
     "type": "string",
     "enum": [
       "mcp"
     ],
     "x-stainless-const": true
   }
 }
}

Fields

name: Option<String>

server_label: String

The label of the MCP server to use.

type_: ToolChoiceMcpType

For MCP tools, the type is always mcp.

Trait Implementations

impl Clone for ToolChoiceMcp

fn clone(&self) -> ToolChoiceMcp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoiceMcp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceMcp

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolChoiceMcp> for RealtimeBetaResponseCreateParamsToolChoice

fn from(value: ToolChoiceMcp) -> Self

Converts to this type from the input type.

impl From<ToolChoiceMcp> for RealtimeResponseCreateParamsToolChoice

fn from(value: ToolChoiceMcp) -> Self

Converts to this type from the input type.

impl From<ToolChoiceMcp> for RealtimeSessionCreateRequestGaToolChoice

fn from(value: ToolChoiceMcp) -> Self

Converts to this type from the input type.

impl From<ToolChoiceMcp> for RealtimeSessionCreateResponseGaToolChoice

fn from(value: ToolChoiceMcp) -> Self

Converts to this type from the input type.

impl From<ToolChoiceMcp> for ToolChoiceParam

fn from(value: ToolChoiceMcp) -> Self

Converts to this type from the input type.

impl Serialize for ToolChoiceMcp

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

where __S: Serializer,

Serialize this value into the given Serde serializer.