Skip to main content
Glama
Sign In
Vobiz MCP Server

Vobiz MCP Server

Official
by vobiz-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List opt-outs

list_opt_outs
Read-only

Retrieve phone numbers that opted out of messages from your account, newest first, showing channel, reason, and source. Paginate results with limit and offset.

Instructions

List the numbers that opted out of messages from this account, newest first (GET /api/v1/sms/opt-outs): phoneNumber, channel, reason, source (inbound = a STOP keyword reply, manual = added through the API or console) and syncedToProvider. Page with limit (default 20, max 100) and offset; the end is reached when a page returns fewer than limit (there is no total). To test one number use check_opt_out; to block or unblock use add_opt_out or remove_opt_out.

Input Schema

NameRequiredDescriptionDefault
limitNoPage size, 1-100 (default 20).
offsetNoNumber of entries 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).
countNoEntries on this page.
opt_outsNoEntries on this page, newest first: id, phoneNumber, channel, reason, source (inbound or manual), syncedToProvider, createdAt.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • addedInput schema / properties / offset / description
      Added value: +"Number of entries 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": {
+    "count": {
+      "description": "Entries 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"
+    },
+    "opt_outs": {
+      "description": "Entries on this page, newest first: id, phoneNumber, channel, reason, source (inbound or manual), syncedToProvider, createdAt.",
+      "items": {},
+      "type": "array"
+    }
+  },
+  "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 and openWorldHint, so the safety profile is covered. The description adds real behavioral context beyond that: sort order ('newest first'), pagination termination ('the end is reached when a page returns fewer than limit (there is no total)'), and the meaning of the source field (inbound = STOP keyword reply, manual = API/console). These are useful traits not present in structured fields.

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?

Two dense sentences with zero filler. The resource leads, followed by returned fields, pagination behavior, and the sibling routing as the closing clause—well front-loaded and every sentence earns its place.

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-value explanation is unnecessary, and the description still covers ordering, paging, the source-field semantics, and the related-tool boundary. Nothing an agent needs to call this 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 defaults and ranges (limit 1-100 default 20, offset) are already documented. The description adds pagination flow semantics the schema lacks: the termination condition and the absence of a total count, which is what an agent actually needs to page correctly.

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 ('List the numbers that opted out of messages from this account') and immediately distinguishes itself from the sibling tools that act on a single number. An agent can identify exactly what this returns without inspecting 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?

Explicitly routes the agent: 'To test one number use check_opt_out; to block or unblock use add_opt_out or remove_opt_out.' Both the when-to-use and the alternatives are named, leaving nothing to inference.

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