Execute a API tool with MCP

When to use this tool

Use voiceflow_api_tool with get_schema to discover inputs, then execute to run a saved API tool without a conversation. This page covers those two operations; other management operations on the tool remain available.

Access and effects

Use an authenticated Voiceflow MCP connection with access to the project and environment. Schema discovery requires the corresponding read permission; execution requires execute permission. Calls use saved draft resources and can change external systems. Obtain authorization for the intended external action before executing it.

Inputs

The current MCP surface uses an operation object with name and payload.

For schema discovery, omit body. Functions and API tools require all declared inputs as strings; other tools follow their input schema.

Result

Schema discovery describes the accepted inputs. Function schemas also describe output variables and exit paths; integration schemas list catalog actions and connection status; MCP tool schemas include the server ID and JSON Schema. Execution returns the shared result fields and resource-specific output inside the MCP response. Inspect tool errors as well as the execution success field.

Invocation example

Tool: voiceflow_api_tool. This is the argument object for execution; replace identifiers and fill inputs from get_schema before calling.

{
  "operation": {
    "name": "execute",
    "payload": {
      "projectID": "PROJECT_ID",
      "environmentAlias": "ENVIRONMENT",
      "toolID": "RESOURCE_ID",
      "body": {
        "inputs": {}
      }
    }
  }
}

Related tools

Run tools without a conversation · Execution behavior · MCP overview · REST execution reference · REST schema reference

Failures and follow-up

For unknown or missing inputs, refresh the schema. For missing credentials, repair the saved connection instead of retrying. A tool error is different from an MCP transport failure. After a timeout, verify whether the external action occurred before repeating it. See the execution guide’s troubleshooting.