Skip to main content
Glama
Sign In
Vobiz MCP Server

Vobiz MCP Server

Official
by vobiz-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get a broadcast

get_broadcast
Read-only

Retrieve one SMS broadcast by ID to see its template, status, schedule, rate, DLT ids and live stats, and poll it to track progress.

Instructions

Return one broadcast by broadcast_id (GET /api/v1/sms/broadcasts/{id}): name, sender, template with {{variable}} placeholders, status and pauseReason, scheduledAt, ratePerSecond, tag, DLT ids and freshly counted stats (total, pending, sent, delivered, failed, optedOut, skipped). Poll it while a broadcast is running to follow progress. An id that is not on this account returns the not_found error; find ids with list_broadcasts.

Input Schema

NameRequiredDescriptionDefault
broadcast_idYesBroadcast id, as listed by list_broadcasts or shown in the Vobiz console.

Output Schema

NameRequiredDescriptionDefault
okNoTrue on success; false when the result is an error (then error, message and retryable are set).
broadcastNoThe broadcast: id, name, from, channel, template, status, pauseReason, scheduledAt, ratePerSecond, tag, dltEntityId, dltHeaderId, dltTemplateId, columns, stats, createdAt, startedAt, completedAt.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • changedInput schema / properties / broadcast_id / description
      Previous value: -"Broadcast ID."New value: +"Broadcast id, as listed by list_broadcasts or shown in the Vobiz console."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "broadcast": {
+      "description": "The broadcast: id, name, from, channel, template, status, pauseReason, scheduledAt, ratePerSecond, tag, dltEntityId, dltHeaderId, dltTemplateId, columns, stats, createdAt, startedAt, completedAt."
+    },
+    "ok": {
+      "description": "True on success; false when the result is an error (then error, message and retryable are set).",
+      "type": "boolean"
+    }
+  },
+  "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=true, so safety is covered. The description adds genuinely non-obvious behavior: the cross-account not_found error and the polling-for-progress pattern. It does not cover rate limits or auth, so it stops short of 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 purpose, but the long inline enumeration of every returned field (total, pending, sent, delivered, failed, optedOut, skipped) partly duplicates the output schema. Three sentences remain efficient overall.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Because an output schema exists, enumerating return fields is redundant rather than additive. The description nonetheless includes the error semantics and polling guidance an agent needs, so it is essentially complete for a one-param read tool.

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 is fully documented there (including its pattern). The description only restates the domain of valid ids and the failure mode, so the baseline 3 is appropriate.

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 (return) and resource (one broadcast) with the endpoint, and names the singular/plural distinction against list_broadcasts. An agent can tell it apart from the sibling listing tool 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?

"Poll it while a broadcast is running to follow progress" gives explicit when-to-use, and "find ids with list_broadcasts" routes to the correct alternative when the id is unknown. The not_found condition for out-of-account ids is stated explicitly.

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