Discover MCP Child Tools

from vapi import Vapi
client = Vapi(
    token="YOUR_TOKEN_HERE"
)
client.tools.tool_controller_mcp_child_tools_discover(
    id="id"
)

[
  {
    "id": "tool-child-1234",
    "orgId": "org-5678",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "messages": [
      {
        "contents": [
          {
            "type": "text",
            "text": "Starting the child tool execution now.",
            "language": "en"
          }
        ],
        "type": "request-start",
        "blocking": false,
        "content": "Starting the child tool execution now.",
        "conditions": [
          {
            "operator": "eq",
            "param": "userInput",
            "value": "start"
          }
        ]
      }
    ],
    "server": {
      "timeoutSeconds": 20,
      "credentialId": "550e8400-e29b-41d4-a716-446655440000",
      "staticIpAddressesEnabled": false,
      "encryptedPaths": [
        "request.body.sensitiveData"
      ],
      "url": "https://childtool.example.com/api/call",
      "headers": {
        "Authorization": "Bearer abcdef1234567890"
      },
      "backoffPlan": {
        "type": "fixed",
        "maxRetries": 3,
        "baseDelaySeconds": 2,
        "excludedStatusCodes": [
          400,
          401,
          403,
          404
        ]
      }
    },
    "rejectionPlan": {
      "conditions": [
        {
          "type": "regex",
          "regex": "\\b(cancel|stop|wait)\\b"
        }
      ]
    },
    "metadata": {
      "protocol": "sse"
    },
    "type": "mcp"
  }
]

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Response

idstring

This is the unique identifier for the tool.

orgIdstring

This is the unique identifier for the organization that this tool belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the tool was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the tool was last updated.

messageslist of objects or null

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.

serverobject or null

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.

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.

rejectionPlanobject or null

This is the plan to reject a tool call based on the conversation state.

// Example 1: Reject endCall if user didn’t say goodbye

1 {
2   conditions: [{
3     type: 'regex',
4     regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b',
5     target: { position: -1, role: 'user' },
6     negate: true  // Reject if pattern does NOT match
7   }]
8 }

// Example 2: Reject transfer if user is actually asking a question

1 {
2   conditions: [{
3     type: 'regex',
4     regex: '\\?',
5     target: { position: -1, role: 'user' }
6   }]
7 }

// Example 3: Reject transfer if user didn’t mention transfer recently

1 {
2   conditions: [{
3     type: 'liquid',
4     liquid: `{% assign recentMessages = messages | last: 5 %}
5 {% assign userMessages = recentMessages | where: 'role', 'user' %}
6 {% assign mentioned = false %}
7 {% for msg in userMessages %}
8   {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}
9     {% assign mentioned = true %}
10     {% break %}
11   {% endif %}
12 {% endfor %}
13 {% if mentioned %}
14   false
15 {% else %}
16   true
17 {% endif %}`
18   }]
19 }

// Example 4: Reject endCall if the bot is looping and trying to exit

1 {
2   conditions: [{
3     type: 'liquid',
4     liquid: `{% assign recentMessages = messages | last: 6 %}
5 {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}
6 {% if userMessages.size < 3 %}
7   false
8 {% else %}
9   {% assign msg1 = userMessages[0].content | downcase %}
10   {% assign msg2 = userMessages[1].content | downcase %}
11   {% assign msg3 = userMessages[2].content | downcase %}
12   {% comment %} Check for repetitive messages {% endcomment %}
13   {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}
14     true
15   {% comment %} Check for common loop phrases {% endcomment %}
16   {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}
17     true
18   {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}
19     true
20   {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}
21     true
22   {% else %}
23     false
24   {% endif %}
25 {% endif %}`
26   }]
27 }

This is the plan to reject a tool call based on the conversation state. // Example 1: Reject endCall if user didn't say goodbye ```json { conditions: [{ type: 'regex', regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b', target: { position: -1, role: 'user' }, negate: true // Reject if pattern does NOT match }] } ``` // Example 2: Reject transfer if user is actually asking a question ```json { conditions: [{ type: 'regex', regex: '\\?', target: { position: -1, role: 'user' } }] } ``` // Example 3: Reject transfer if user didn't mention transfer recently ```json { conditions: [{ type: 'liquid', liquid: `{% assign recentMessages = messages | last: 5 %} {% assign userMessages = recentMessages | where: 'role', 'user' %} {% assign mentioned = false %} {% for msg in userMessages %} {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %} {% assign mentioned = true %} {% break %} {% endif %} {% endfor %} {% if mentioned %} false {% else %} true {% endif %}` }] } ``` // Example 4: Reject endCall if the bot is looping and trying to exit ```json { conditions: [{ type: 'liquid', liquid: `{% assign recentMessages = messages | last: 6 %} {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %} {% if userMessages.size < 3 %} false {% else %} {% assign msg1 = userMessages[0].content | downcase %} {% assign msg2 = userMessages[1].content | downcase %} {% assign msg3 = userMessages[2].content | downcase %} {% comment %} Check for repetitive messages {% endcomment %} {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %} true {% comment %} Check for common loop phrases {% endcomment %} {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %} true {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %} true {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %} true {% else %} false {% endif %} {% endif %}` }] } ```

metadataobject or null

{
  conditions: [{
    type: 'regex',
    regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b',
    target: { position: -1, role: 'user' },
    negate: true  // Reject if pattern does NOT match
  }]
}

{
  conditions: [{
    type: 'regex',
    regex: '\\?',
    target: { position: -1, role: 'user' }
  }]
}

{
  conditions: [{
    type: 'liquid',
    liquid: `{% assign recentMessages = messages | last: 5 %}
{% assign userMessages = recentMessages | where: 'role', 'user' %}
{% assign mentioned = false %}
{% for msg in userMessages %}
  {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}
    {% assign mentioned = true %}
    {% break %}
  {% endif %}
{% endfor %}
{% if mentioned %}
  false
{% else %}
  true
{% endif %}`
  }]
}

{
  conditions: [{
    type: 'liquid',
    liquid: `{% assign recentMessages = messages | last: 6 %}
{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}
{% if userMessages.size < 3 %}
  false
{% else %}
  {% assign msg1 = userMessages[0].content | downcase %}
  {% assign msg2 = userMessages[1].content | downcase %}
  {% assign msg3 = userMessages[2].content | downcase %}
  {% comment %} Check for repetitive messages {% endcomment %}
  {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}
    true
  {% comment %} Check for common loop phrases {% endcomment %}
  {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}
    true
  {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}
    true
  {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}
    true
  {% else %}
    false
  {% endif %}
{% endif %}`
  }]
}

1	{
2	conditions: [{
3	type: 'regex',
4	regex: '(?i)\\b(bye\|goodbye\|farewell\|see you later\|take care)\\b',
5	target: { position: -1, role: 'user' },
6	negate: true // Reject if pattern does NOT match
7	}]
8	}

1	{
2	conditions: [{
3	type: 'regex',
4	regex: '\\?',
5	target: { position: -1, role: 'user' }
6	}]
7	}

1	{
2	conditions: [{
3	type: 'liquid',
4	liquid: `{% assign recentMessages = messages \| last: 5 %}
5	{% assign userMessages = recentMessages \| where: 'role', 'user' %}
6	{% assign mentioned = false %}
7	{% for msg in userMessages %}
8	{% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}
9	{% assign mentioned = true %}
10	{% break %}
11	{% endif %}
12	{% endfor %}
13	{% if mentioned %}
14	false
15	{% else %}
16	true
17	{% endif %}`
18	}]
19	}