Skip to main content
Glama
Sign In
Vobiz MCP Server

Vobiz MCP Server

Official
by vobiz-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get SIP trunk

get_sip_trunk
Read-only

Retrieve a SIP trunk's full configuration by trunk_id, including domain, status, direction, call limits, transport and recording settings; credentials are redacted.

Instructions

Return one SIP trunk's full configuration by trunk_id (GET /trunks/{id}): domain, status, direction, CPS and concurrent-call limits, transport and recording settings. SIP username and password are replaced by "[redacted]". A trunk_id that is not on this account returns the not_found error. To find trunk IDs use list_sip_trunks.

Input Schema

NameRequiredDescriptionDefault
trunk_idYesTrunk UUID, as returned by list_sip_trunks or create_sip_trunk.

Output Schema

NameRequiredDescriptionDefault
okNoTrue on success; false when the result is an error (then error, message and retryable are set).
trunkNoOne SIP trunk: id, name, domain, status, direction, CPS and concurrent-call limits, transport, recording settings; username and password are "[redacted]".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / trunk_id / description
      Added value: +"Trunk UUID, as returned by list_sip_trunks or create_sip_trunk."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "ok": {
+      "description": "True on success; false when the result is an error (then error, message and retryable are set).",
+      "type": "boolean"
+    },
+    "trunk": {
+      "description": "One SIP trunk: id, name, domain, status, direction, CPS and concurrent-call limits, transport, recording settings; username and password are \"[redacted]\"."
+    }
+  },
+  "type": "object"
+}
  2. First observedv1.1.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered. The description adds non-obvious behavior the annotations cannot convey: credentials come back as '[redacted]', and an unknown trunk_id yields a not_found error. It does not mention rate limits or account/permission requirements, so it is not a 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 sentences, front-loaded with the purpose, then returned fields, then the sink/aid for obtaining an ID. No filler; each sentence carries distinct information.

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, yet the description still flags redaction and the not_found failure path — the two things an agent must anticipate when calling a getter. Nothing needed to invoke it correctly 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 already documents its UUID pattern and origin. The description only restates 'by trunk_id' without adding format, sourcing, or validation nuance 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?

States a specific verb and resource ('Return one SIP trunk's full configuration by trunk_id') and even maps to the underlying endpoint (GET /trunks/{id}). This clearly separates it from the sibling list_sip_trunks, which takes no trunk identifier.

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

Usage Guidelines4/5

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

Explicitly tells the agent where to get the required identifier: 'To find trunk IDs use list_sip_trunks.' That removes the main usage ambiguity. It stops short of stating when a full get is preferable to reading the list result directly, so it is strong but not exhaustive.

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