vapi_client/models/
mcp_tool.rs

1/*
2 * Vapi API
3 *
4 * Voice AI for developers.
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct McpTool {
16    /// These are the messages that will be spoken to the user as the tool is running.  For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
17    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
18    pub messages: Option<Vec<models::CreateDtmfToolDtoMessagesInner>>,
19    /// The type of tool. \"mcp\" for MCP tool.
20    #[serde(rename = "type")]
21    pub r#type: TypeTrue,
22    ///    This is the server where a `tool-calls` webhook will be sent.    Notes:   - Webhook is sent to this server when a tool call is made.   - Webhook contains the call, assistant, and phone number objects.   - Webhook contains the variables set on the assistant.   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.   - Webhook expects a response with tool call result.
23    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
24    pub server: Option<models::Server>,
25    /// This is the unique identifier for the tool.
26    #[serde(rename = "id")]
27    pub id: String,
28    /// This is the unique identifier for the organization that this tool belongs to.
29    #[serde(rename = "orgId")]
30    pub org_id: String,
31    /// This is the ISO 8601 date-time string of when the tool was created.
32    #[serde(rename = "createdAt")]
33    pub created_at: String,
34    /// This is the ISO 8601 date-time string of when the tool was last updated.
35    #[serde(rename = "updatedAt")]
36    pub updated_at: String,
37    /// This is the function definition of the tool.  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.  An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.
38    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
39    pub function: Option<models::OpenAiFunction>,
40}
41
42impl McpTool {
43    pub fn new(
44        r#type: TypeTrue,
45        id: String,
46        org_id: String,
47        created_at: String,
48        updated_at: String,
49    ) -> McpTool {
50        McpTool {
51            messages: None,
52            r#type,
53            server: None,
54            id,
55            org_id,
56            created_at,
57            updated_at,
58            function: None,
59        }
60    }
61}
62/// The type of tool. \"mcp\" for MCP tool.
63#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
64pub enum TypeTrue {
65    #[serde(rename = "mcp")]
66    Mcp,
67}
68
69impl Default for TypeTrue {
70    fn default() -> TypeTrue {
71        Self::Mcp
72    }
73}
vapi_client/models/mcp_tool.rs

vapi_client/models/
mcp_tool.rs
