Skip to main content
Glama
Vapi MCP Server

Vapi MCP Server

Official
by VapiAI

create_simulation_suite

Groups simulations into a suite so related test scenarios can be run together, enabling organized batch execution.

Instructions

Creates a simulation suite that groups simulations so they can be run together

Input Schema

NameRequiredDescriptionDefault
nameYesThis is the name of the simulation suite.
pathNoOptional folder path for organizing simulation suites. Supports up to 3 levels (e.g., "dept/feature/variant"). Maps to GitOps resource folder structure.
simulationIdsYesThis is the list of simulation IDs to include in the suite.
additionalFieldsNoAdditional documented API fields. The merged request is validated against the bundled Vapi OpenAPI schema.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.0

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full behavioral burden, yet it says nothing about permissions, whether suite names must be unique, what happens on duplicate name or invalid simulationIds, or whether the operation is idempotent. It only explains the conceptual grouping effect, leaving all mutation-risk context to inference.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single well-formed sentence with the verb and resource front-loaded and zero filler. It is efficient, though the brevity is part of why coverage gaps exist elsewhere rather than a flaw in the prose itself.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a straightforward create operation with a fully documented four-parameter schema, the description covers the what but not the return value (no output schema) or failure/duplicate behavior. Adequate as minimum viable, but a creation tool with no annotations should say more about what the caller gets back.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so name, path, simulationIds, and additionalFields are already documented, including the folder-path pattern and GitOps mapping. The description adds no parameter-level meaning beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Creates a simulation suite") and adds the semantic effect — grouping simulations so they can be run together — which distinguishes it from sibling create_simulation and points toward run_simulations. It does not explicitly name those siblings, so differentiation is implicit rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: the phrase "so they can be run together" hints that a suite exists to be executed as a batch, but the description never says when to create a suite versus individually creating simulations, nor does it reference run_simulations as the follow-up action. No prerequisites (e.g., simulations must already exist) or exclusions are given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.