Skip to main content
Glama

Delete SIP trunk

delete_sip_trunk
DestructiveIdempotent

Soft-delete a Vobiz SIP trunk: remove it from listings, stop its SIP domain, and unlink routed numbers while retaining account-level credentials and origination URIs.

Instructions

Soft-delete a Vobiz SIP trunk: it disappears from list_sip_trunks, its SIP domain stops accepting calls, and numbers routed to it are unlinked and stop receiving calls through it. The credentials, IP ACL entries and origination URIs it referenced are account-level and are kept. To pause a trunk and keep its configuration, use update_sip_trunk with trunk_status: disabled instead. An unknown trunk_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 SIP trunk. If your client supports MCP elicitation, the server asks the user to approve directly and this flag is not relied on; otherwise it is your attestation that the user approved.
trunk_idYesSIP trunk UUID: the trunk_id returned by list_sip_trunks, get_sip_trunk or create_sip_trunk.

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`.
deletedNoTrue when the record was deleted by this call.
trunk_idNoThe trunk that was deleted.
http_statusNoHTTP status Vobiz answered with.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.4.2
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true, set only after the user explicitly approved: deleting this SIP trunk."New value: +"Must be true, set only after the user explicitly approved: deleting this SIP trunk. If your client supports MCP elicitation, the server asks the user to approve directly and this flag is not relied on; otherwise it is your attestation that the user approved."
    • addedInput schema / properties / trunk_id / description
      Added value: +"SIP trunk UUID: the trunk_id returned by list_sip_trunks, get_sip_trunk or create_sip_trunk."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "deleted": {
      +      "const": true,
      +      "description": "True when the record was deleted by this call.",
      +      "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"
      +    },
      +    "trunk_id": {
      +      "description": "The trunk that was deleted.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observedv1.1.1

TDQS

A4.9/5.0
Behavior5/5

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

Goes well beyond the annotations: discloses that the delete is soft, what disappears, what is preserved (account-level credentials, IP ACL entries, origination URIs are kept), the not_found behavior for unknown ids, and the env/confirm gating. This is exactly the extra context annotations cannot carry.

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?

Every sentence earns its place, and the primary effect (soft-delete) is front-loaded ahead of the preservation details, the alternative, and the gating. No filler or redundancy despite covering a lot of ground.

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 tool with an output schema, all the decision-relevant information is present: effects, side effects, what survives, error behavior, safety gating, and the non-destructive alternative. Nothing an agent needs before invoking it 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, but the description adds value the schema lacks: the not_found outcome for an unknown trunk_id and the runtime gating tied to confirm. It does not restate the UUID format or the elicitation semantics, which the schema already covers.

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 (soft-delete) and resource (Vobiz SIP trunk), then spells out the concrete effects: disappears from list_sip_trunks, SIP domain stops accepting calls, routed numbers unlinked. This clearly distinguishes it from update_sip_trunk and from the credential/ACL/origination deletion tools that are named as siblings.

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 a trunk and keep its configuration, use update_sip_trunk with trunk_status: disabled instead.' It also states the gating prerequisites (VOBIZ_ENABLE_PROVISIONING and confirm: true), so the agent knows both when to use it and when not to.

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