Skip to main content
Glama
Sign In
Vobiz MCP Server

Vobiz MCP Server

Official
by vobiz-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get voice application

get_application
Read-only

Retrieve a Vobiz voice application's full configuration by numeric app_id to inspect answer, hangup, fallback URLs, methods, flags, SIP URI, and status.

Instructions

Return one Vobiz voice application's full configuration by app_id: name, answer_url and answer_method (where Vobiz fetches VobizXML for inbound calls), hangup_url and hangup_method, fallback_answer_url and fallback_method, the default_app and default_endpoint_app flags, enabled, sip_uri (dials the application directly), sub_account and timestamps. Use list_applications to find the id or to see several applications at once; linked numbers are not included, use list_phone_numbers for those. An app_id that is not on this account raises not_found.

Input Schema

NameRequiredDescriptionDefault
app_idYesNumeric Vobiz application ID (5-25 digits) from list_applications or create_application. 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`.
applicationNoThe application exactly as Vobiz returned it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / app_id / description
      Added value: +"Numeric Vobiz application ID (5-25 digits) from list_applications or create_application. Unknown ids raise not_found."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "application": {
+      "additionalProperties": {},
+      "description": "The application exactly as Vobiz returned it.",
+      "properties": {
+        "answer_method": {
+          "description": "HTTP method for answer_url: GET or POST.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "answer_url": {
+          "description": "URL fetched for VobizXML when a call reaches a number or endpoint linked to this application.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "app_id": {
+          "description": "Numeric application ID (string of digits).",
+          "type": [
+            "string",
+            "number",
+            "null"
+          ]
+        },
+        "app_name": {
+          "description": "Application name.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "application_type": {
+          "description": "Application type, normally XML.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "created_at": {
+          "description": "Creation timestamp.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "default_app": {
+          "description": "True when this is the account-level default application for new numbers.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "default_endpoint_app": {
+          "description": "True when new SIP endpoints without an application route here.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "enabled": {
+          "description": "False when the application is switched off.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "fallback_answer_url": {
+          "description": "URL used only when answer_url fails; null when none is set.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "fallback_method": {
+          "description": "HTTP method for fallback_answer_url.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "hangup_method": {
+          "description": "HTTP method for hangup_url.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "hangup_url": {
+          "description": "URL notified when the call ends.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "message_method": {
+          "description": "HTTP method for message_url.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "message_url": {
+          "description": "URL notified for inbound messages; null when none is set.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "public_uri": {
+          "description": "True when sip_uri accepts calls from external SIP systems.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "sip_uri": {
+          "description": "SIP URI that reaches this application directly without a number.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "sub_account": {
+          "description": "Sub-account Auth ID that owns the application, or null for the main account.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "updated_at": {
+          "description": "Last-change timestamp.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "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.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety is covered. The description adds real behavioral context beyond that: the not_found error for foreign app_ids, the scope exclusion of linked numbers, and functional meaning for key fields (answer_url is where Vobiz fetches VobizXML, sip_uri dials the application directly). It stops short of auth or rate-limit detail, so 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and the lookup key, then the alternatives. It is dense but every sentence earns its place; however the long mid-sentence field enumeration partly duplicates the output schema, making it longer than strictly necessary.

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 one-parameter read tool with annotations and an output schema, the description covers the remaining agent needs: the alternatives for discovery, the linked-number exclusion, and the exact failure condition. Nothing required 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.

Parameters3/5

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

Schema coverage is 100% and the single app_id parameter already documents the numeric format, its source, and the not_found failure mode. The description restates the 'by app_id' selector but adds no syntax or format meaning 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 Vobiz voice application's full configuration by app_id') and enumerates the configuration surface returned. It also explicitly carves out what it is not ('linked numbers are not included'), which separates it from list_phone_numbers and list_applications.

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?

Gives explicit routing: use list_applications to find the id or to view several applications, and use list_phone_numbers for linked numbers. It also names the precondition for success (the app must belong to this account).

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