Skip to main content
Glama

Stop speech on a live call

stop_speaking
DestructiveIdempotent

Stops text-to-speech started by speak_text on a live call while the call continues. Provide the call UUID to end only that speech.

Instructions

Stop text-to-speech started by speak_text on a LIVE call (DELETE /Call/{uuid}/Speak/); the call itself continues. It does not stop play_audio playback (use stop_audio), 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 speak_text speech 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`.
speakingNoFalse 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 speak_text speech 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"
      +    },
      +    "speaking": {
      +      "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 already declare readOnlyHint=false, idempotentHint=true and destructiveHint=true, covering the safety profile. The description adds meaningful context beyond that: the call itself continues after speech stops, it only targets speak_text output, and a non-live call yields call_not_active. It stops short of noting side effects or timing, but is notably richer than the annotations.

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?

Two tightly packed sentences with no waste: the scope and endpoint come first, then differentiation, then the error case. Every clause earns its place.

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?

An output schema exists so return values need not be explained, and annotations cover the safety profile. The description supplies scope, alternatives and the failure mode, which is everything needed to invoke correctly.

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 is fully documented with pattern and purpose, so the schema does the heavy lifting. The description adds no further syntax or format detail beyond what the schema provides, which is the expected baseline here.

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 (text-to-speech started by speak_text) and scopes it to a LIVE call, with the endpoint DELETE /Call/{uuid}/Speak/. It explicitly distinguishes itself from sibling stop_audio, stop_recording and stop_audio_stream, so an agent can identify it without opening a schema.

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?

Provides an explicit exclusion list naming the three alternatives (stop_audio, stop_recording, stop_audio_stream) and the condition that selects each. Also states the failure mode for non-live calls, leaving nothing to inference.

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