Skip to main content
Glama

Delete SIP endpoint

delete_sip_endpoint
DestructiveIdempotent

Permanently delete a Vobiz SIP endpoint, disconnecting devices and freeing its username. This cannot be undone; to block temporarily, use update_sip_endpoint.

Instructions

Permanently delete a Vobiz SIP endpoint; this cannot be undone. Devices registered with it disconnect immediately and its SIP URI stops working; the username becomes free for a new endpoint. To block a device temporarily, change its password with update_sip_endpoint instead. An unknown endpoint_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 endpoint.
endpoint_idYesNumeric SIP endpoint ID (4-25 digits): endpoint_id from list_sip_endpoints or create_sip_endpoint. 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
endpoint_idNoThe endpoint that was deleted.
http_statusNoHTTP status Vobiz answered with.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / endpoint_id / description
      Added value: +"Numeric SIP endpoint ID (4-25 digits): endpoint_id from list_sip_endpoints or create_sip_endpoint. Unknown ids raise not_found."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "deleted": {
      +      "const": true,
      +      "type": "boolean"
      +    },
      +    "endpoint_id": {
      +      "description": "The endpoint that was deleted.",
      +      "type": "string"
      +    },
      +    "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.7/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses the concrete blast radius (registered devices disconnect immediately, SIP URI stops working, username becomes reusable), the error behavior (not_found), and the feature-flag plus confirmation gating. The annotations only say destructive/idempotent; the description supplies the operational consequences.

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?

Four tight clauses, front-loaded with the destructive action and its consequence, then the alternative, then error and gating notes. No filler sentences.

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 2-param tool with an output schema, everything needed to call it correctly is present: impact, alternative, error case, and authorization/confirmation gates. Return values are correctly left to the output schema.

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 coverage is 100%, so the schema already documents both endpoint_id and confirm. The description reinforces the confirm gating and the not_found behavior for unknown ids but adds no syntax or format detail 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.

Purpose5/5

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

Opens with a specific verb+resource ("Permanently delete a Vobiz SIP endpoint") and immediately states irreversibility. The scope is distinct from delete_sip_trunk and from update_sip_endpoint, which it names as the alternative.

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 states when NOT to use it ("To block a device temporarily, change its password with update_sip_endpoint instead") and names the gating conditions (VOBIZ_ENABLE_PROVISIONING and confirm: true). Both the alternative and the prerequisites are spelled out.

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