openai-client-base 0.16.0

Auto-generated Rust client for the OpenAI API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

/*
 * OpenAI API
 *
 * The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 *
 * The version of the OpenAPI document: 2.3.0
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// AgentToolConfigParamMcp : Tools provided by a remote MCP server.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct AgentToolConfigParamMcp {
    /// The type of the object. Always `mcp`.
    #[serde(rename = "type")]
    pub r#type: Type,
    /// A label used to identify the MCP server in tool calls.
    #[serde(rename = "server_label")]
    pub server_label: String,
    /// The attached vault credential used to authenticate this MCP server. Optional when exactly one attached credential matches the server URL.
    #[serde(rename = "credential_id", skip_serializing_if = "Option::is_none")]
    pub credential_id: Option<String>,
    #[serde(rename = "transport")]
    pub transport: Box<models::McpTransportConfigParam>,
    /// Metadata included with requests to this MCP server.
    #[serde(rename = "request_metadata", skip_serializing_if = "Option::is_none")]
    pub request_metadata: Option<std::collections::HashMap<String, serde_json::Value>>,
    /// The MCP tools the agent may call. All server tools are allowed when omitted.
    #[serde(rename = "allowed_tools", skip_serializing_if = "Option::is_none")]
    pub allowed_tools: Option<Vec<String>>,
    /// Whether this MCP server must initialize before the first turn. Defaults to `false`.
    #[serde(rename = "required", skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,
    #[serde(rename = "connection_origin", skip_serializing_if = "Option::is_none")]
    pub connection_origin: Option<Box<models::AgentToolConfigParamMcpConnectionOrigin>>,
}

impl AgentToolConfigParamMcp {
    /// Tools provided by a remote MCP server.
    pub fn new(
        r#type: Type,
        server_label: String,
        transport: models::McpTransportConfigParam,
    ) -> AgentToolConfigParamMcp {
        AgentToolConfigParamMcp {
            r#type,
            server_label,
            credential_id: None,
            transport: Box::new(transport),
            request_metadata: None,
            allowed_tools: None,
            required: None,
            connection_origin: None,
        }
    }
}
/// The type of the object. Always `mcp`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
    #[serde(rename = "mcp")]
    Mcp,
}

impl Default for Type {
    fn default() -> Type {
        Self::Mcp
    }
}

impl std::fmt::Display for AgentToolConfigParamMcp {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match serde_json::to_string(self) {
            Ok(s) => write!(f, "{}", s),
            Err(_) => Err(std::fmt::Error),
        }
    }
}