Skip to main content
Glama

Stop audio on a live call

stop_audio
DestructiveIdempotent

Stops audio playback started by play_audio on a live call while the call stays connected. Use it to halt prompts or hold music; use stop_speaking to end text-to-speech instead.

Instructions

Stop audio started by play_audio on a LIVE call (DELETE /Call/{uuid}/Play/); the call itself continues. It does not stop text-to-speech (use stop_speaking), a recording (stop_recording) or an audio stream (stop_audio_stream). A call that is not live fails with call_not_active.

Input Schema

NameRequiredDescriptionDefault
call_uuidYesUUID of the live call whose play_audio playback should stop.

Output Schema

NameRequiredDescriptionDefault
okNoTrue on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`.
playingNoFalse once Vobiz accepted the stop request.
call_uuidNoThe call UUID the action was applied to, echoed from the request.
http_statusNoHTTP status Vobiz answered with: 202 when an action was accepted, 204 when one was stopped.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / call_uuid / description
      Added value: +"UUID of the live call whose play_audio playback should stop."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "call_uuid": {
      +      "description": "The call UUID the action was applied to, echoed from the request.",
      +      "type": "string"
      +    },
      +    "http_status": {
      +      "description": "HTTP status Vobiz answered with: 202 when an action was accepted, 204 when one was stopped.",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "ok": {
      +      "description": "True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`.",
      +      "type": "boolean"
      +    },
      +    "playing": {
      +      "const": false,
      +      "description": "False once Vobiz accepted the stop request.",
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observedv1.1.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and idempotentHint=true but say nothing about the scope of destruction; the description clarifies that only playback stops and 'the call itself continues,' which is valuable disambiguation of a destructive-sounding flag. It also discloses the error behavior for non-live calls. It doesn't cover auth/permission requirements or the response shape (though an output schema exists), so it falls short of 5.

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

Conciseness5/5

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

Three tight sentences: scope first, sibling exclusions second, failure mode last. Zero filler, and the most decision-relevant information (live call, play_audio origin) is front-loaded.

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

Completeness5/5

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

For a one-parameter, output-schema-backed mutation tool, the description covers scope, the exact sibling alternatives for each adjacent concept, and the error path. Nothing material to correct invocation is missing.

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% and the single parameter (call_uuid) is documented in the schema including its requiredness, pattern, and meaning. The description adds the constraint that the call must be live, but no additional format or syntax detail. Baseline 3 is appropriate.

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

Purpose5/5

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

States a specific verb (stop) and resource (audio started by play_audio), scopes it to LIVE calls, and names the sibling that started it (play_audio). It also explicitly distinguishes from stop_speaking, stop_recording, and stop_audio_stream, so an agent can disambiguate among a dense sibling set.

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

Usage Guidelines5/5

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

Explicitly says when to use this (audio started by play_audio on a live call) and when not to (TTS, recording, audio stream — each with the correct alternative named). It also gives a failure condition (non-live call returns call_not_active), which is exactly the routing guidance an agent needs.

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

Deploy Server

Other Tools