Skip to main content
Glama
Sign In
Vobiz MCP Server

Vobiz MCP Server

Official
by vobiz-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List broadcasts

list_broadcasts
Read-only

Retrieve bulk-message broadcasts on your account, newest first, with status and delivery stats. Page results using limit and offset to review campaign performance.

Instructions

List the bulk-message broadcasts on this account, newest first (GET /api/v1/sms/broadcasts), each with its status (draft, scheduled, running, paused, completed, cancelled or failed) and freshly counted stats (total, pending, sent, delivered, failed, optedOut, skipped). Page with limit (default 50, max 500) and offset; total is the account-wide count, so page until offset reaches it. For one broadcast's template, schedule and send rate use get_broadcast. This server only reads broadcasts; they are created and launched in the Vobiz console.

Input Schema

NameRequiredDescriptionDefault
limitNoPage size, 1-500 (default 50).
offsetNoNumber of broadcasts to skip before the page starts (default 0). Add the page size to it for the next page.

Output Schema

NameRequiredDescriptionDefault
okNoTrue on success; false when the result is an error (then error, message and retryable are set).
countNoBroadcasts on this page.
totalNoAccount-wide number of broadcasts, or null when Vobiz did not report it.
broadcastsNoBroadcasts on this page, newest first: id, name, from, channel, template, status, pauseReason, scheduledAt, ratePerSecond, tag, stats, createdAt, startedAt, completedAt.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / offset / description
      Added value: +"Number of broadcasts to skip before the page starts (default 0). Add the page size to it for the next page."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "broadcasts": {
+      "description": "Broadcasts on this page, newest first: id, name, from, channel, template, status, pauseReason, scheduledAt, ratePerSecond, tag, stats, createdAt, startedAt, completedAt.",
+      "items": {},
+      "type": "array"
+    },
+    "count": {
+      "description": "Broadcasts on this page.",
+      "type": "number"
+    },
+    "ok": {
+      "description": "True on success; false when the result is an error (then error, message and retryable are set).",
+      "type": "boolean"
+    },
+    "total": {
+      "description": "Account-wide number of broadcasts, or null when Vobiz did not report it."
+    }
+  },
+  "type": "object"
+}
  2. First observedv1.1.1

TDQS

A4.7/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 still adds real behavioral context: stats are 'freshly counted' per call, the enumerable status values, the pagination contract with limit default 50 / max 500, and the important constraint that this server cannot create or launch broadcasts. It stops short of auth, rate-limit, or error behavior, so it is strong but not exhaustive.

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 dense sentences, all front-loaded with the core action first, then pagination mechanics, then the sibling redirect. No filler, no repetition of the title, and every clause carries information the agent needs.

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 two-parameter read-only list tool with an output schema, the description covers purpose, ordering, pagination strategy, status values, and the boundary of what this server can do. Nothing an agent needs in order 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.

Parameters4/5

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

Schema coverage is 100%, so limit and offset are already documented and the baseline would be 3. The description adds meaning beyond the schema by explaining that 'total' is the account-wide count and that the caller should page until offset reaches it, which is genuine usage semantics rather than restatement.

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?

The description opens with a specific verb and resource ('List the bulk-message broadcasts on this account'), states ordering ('newest first'), and explicitly separates itself from the sibling get_broadcast, which returns a single broadcast. An agent can distinguish this from get_broadcast and list_messages without opening any 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?

It names the alternative and the condition that selects it ('For one broadcast's template, schedule and send rate use get_broadcast'), and adds a when-not constraint by stating broadcasts are created and launched in the Vobiz console rather than through this server. Both routing decisions an agent faces are covered 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