Skip to main content
Glama

get_broadcast_details

Read-only

Return full details for a single broadcast: status, schedule, recurrence rule, linked flow, delivery breakdown by status, failureReason (why a FAILED broadcast failed) and deliveryErrors (the distinct per-recipient error texts with counts, top 5). recipientCount is the number of delivery rows once the broadcast has started sending. Before that it is a live count of the audience only when the audience has no filter. null means NOT COMPUTED, never zero: a filtered audience is evaluated when the broadcast sends, and get_broadcast_details reads delivery rows only, so it is null for every broadcast that has none yet. Read-only. Call list_broadcasts first to find the broadcastId. For per-message-block engagement stats use get_broadcast_analytics instead.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "broadcastId": "<broadcastId>"
    },
    "name": "get_broadcast_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
broadcastIdYesRequired. Broadcast id, as returned by list_broadcasts.
applicationIdNoApplication (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / applicationId / description
      Added value: +"Application (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id."
    • addedInput schema / properties / broadcastId / description
      Added value: +"Required. Broadcast id, as returned by list_broadcasts."
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, so safety is covered, yet the description still adds substantive behavior: deliveryErrors is capped at the top 5 distinct texts, recipientCount has different meanings before and after sending begins, and null is defined as NOT COMPUTED rather than zero, with the reason (filtered audiences are evaluated at send time and this tool reads delivery rows only). That null-vs-zero rule is exactly the kind of nuance annotations cannot carry and would otherwise cause an agent to misreport data.

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-loads the returned field inventory, which is the right priority for a detail-fetch tool, and the long null-semantics sentence is dense but earns its length by preventing a concrete misreading. Slightly less disciplined in ordering, since "Read-only" and the list_broadcasts prerequisite arrive after the return-value discussion rather than up front.

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?

There is no output schema, so the description carries the full burden of explaining return values and does so field by field, including the one ambiguous case (recipientCount null) and the truncation on deliveryErrors. Combined with the sibling routing note, nothing an agent needs to call this correctly or interpret the result 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%, so both parameters are already documented, including the applicationId defaulting rule and the MCP_APPLICATION_REQUIRED failure mode. The description only echoes broadcastId indirectly via the list_broadcasts pointer and says nothing about applicationId. Baseline 3 is appropriate when the schema carries the semantic load.

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?

"Return full details for a single broadcast" names a specific verb and resource, and the enumerated payload (status, schedule, recurrence rule, linked flow, delivery breakdown, failureReason, deliveryErrors) pins down exactly which fields this tool exposes. It also explicitly separates itself from the sibling get_broadcast_analytics, so an agent can pick between them without opening a 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?

Gives a concrete prerequisite ("Call list_broadcasts first to find the broadcastId") and an explicit routing rule away from the tool ("For per-message-block engagement stats use get_broadcast_analytics instead"). Both the when and the when-not are stated rather than implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.