Skip to main content
Glama

Delete trunk credential

delete_trunk_credential
DestructiveIdempotent

Permanently delete a Vobiz trunk credential to revoke SIP authentication, remove it from referencing trunks, and refuse future PBX or device access. Requires explicit confirmation.

Instructions

Delete a trunk credential from this Vobiz account; this cannot be undone. Any PBX or device authenticating with it is refused from then on, and trunks that referenced it lose that credential; Vobiz may refuse while it is in use by active calls. To pause access and keep the credential, use update_trunk_credential with enabled: false. An unknown credential_id raises not_found. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.

Input Schema

NameRequiredDescriptionDefault
confirmYesMust be true, set only after the user explicitly approved: deleting this trunk credential.
credential_idYesTrunk credential UUID: the id from list_trunk_credentials or create_trunk_credential. Unknown ids raise not_found.

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`.
deletedNo
http_statusNoHTTP status Vobiz answered with.
credential_idNoThe credential that was deleted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / credential_id / description
      Added value: +"Trunk credential UUID: the id from list_trunk_credentials or create_trunk_credential. Unknown ids raise not_found."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "credential_id": {
      +      "description": "The credential that was deleted.",
      +      "type": "string"
      +    },
      +    "deleted": {
      +      "const": true,
      +      "type": "boolean"
      +    },
      +    "http_status": {
      +      "description": "HTTP status Vobiz answered with.",
      +      "type": "number"
      +    },
      +    "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"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observedv1.1.1

TDQS

A4.8/5.0
Behavior5/5

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

Beyond destructiveHint=true, the description discloses that the delete is irreversible, that authenticating PBX/devices are refused afterwards, that referencing trunks lose the credential, that Vobiz may refuse while calls are active, and that unknown ids raise not_found. The only nuance is that a repeated delete raising not_found sits in mild tension with idempotentHint=true, but the safety-critical behavior is fully disclosed.

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?

Front-loaded with the irreversible consequence, and every clause (side effects, alternative, error, gating) earns its place. It is a single dense semicolon-chained sentence, which is efficient but slightly harder to scan than a short split would be.

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 destructive provisioned delete with annotations covering the safety profile and an output schema covering returns, the description supplies the consequences, the safer alternative, the error case, and the gating flags. Nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description still adds meaning by tying confirm: true to the gating requirement and by stating that an unknown credential_id raises not_found. It does not add format or syntax beyond the schema, which is already complete.

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 and resource ("Delete a trunk credential from this Vobiz account") and immediately distinguishes this from the sibling update_trunk_credential. An agent can identify the operation and its scope without opening the 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?

Explicitly names the alternative and the condition that selects it: "To pause access and keep the credential, use update_trunk_credential with enabled: false." It also states the confirm requirement and the VOBIZ_ENABLE_PROVISIONING gate, 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