Skip to main content
Glama

Broadcast Ping

broadcast

Send a custom ping to a room the account belongs to. Pass data.checklist.items to send a checklist the room ticks through together; read the ticks back as checklist_state. Rate-limited. In someone else's personal room only a Pro account may send it, text only (a link in the message is refused too), without title, is_urgent or requires_ack (all three are ignored there), and it counts toward the visitor's two-ping cap; otherwise use trigger_quick_action there.

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": {
      "invite_code": "<invite_code>",
      "message": "<message>"
    },
    "name": "broadcast"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataNoArbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, data.checklist for a checklist, and data.url + data.button_label are reserved for a tappable link ping. data.actions is reserved for up to 3 buttons.
tagsNoUp to 10 labels to file this ping under, so history can later be filtered by one (list_notifications and wait_for_notification take a tag). Each is 1 to 32 characters: lowercase letters, digits, "-" and "_", starting with a letter or digit. Trimmed, lowercased and de-duplicated for you.
titleNoOptional headline. Defaults to the room name, which someone else's personal room always keeps.
messageYesPing body text (max 120 characters in private rooms, 160 in public rooms).
ack_modeNoWith requires_ack: any (default) resolves on the first confirmation; all waits for every original eligible recipient. Read action_state.confirmed_count and required_count for progress.
reply_toNoId of the ping this one answers (notification id or correlation id).
is_urgentNoDeliver time-sensitive so the ping breaks through Focus / Do Not Disturb and reaches members who muted the room or you (a block still wins). Independent of requires_ack: urgent affects delivery only and asks nothing of the recipient.
action_iconNoOptional emoji shown with the ping.
invite_codeYesRoom invite code.
replace_keyNoYour own handle for "the ping I keep updating" (1 to 64 characters: letters, digits and . _ : -). Only on a server that has replacing turned on, which is when replace_notification is in your tool list: there a send with a replace_key replaces your earlier ping with the same key in the same room, instead of sending a new one, while that ping is under 24 hours old, replaced fewer than 20 times and replaceable (see replace_notification); the answer is then 200 with the same id and replaced: true. Otherwise, and always while replace_notification is not listed, a new ping is sent and keeps the key. A send that asks for something a replacement cannot do (requires_ack, is_urgent, attachment_ids, tags, action_number, or a different correlation_id, reply_to or action_icon) always sends a new ping.
requires_ackNoKeep this ping open until its confirmation rule is met, and show it as a lock-screen card with an Acknowledge button. Does not raise the interruption level on its own — combine with is_urgent for an ack that also breaks through Focus.
action_numberNoOptional quick-action slot to attribute the ping to.
attachment_idsNoIds of up to 4 uploaded attachments (see upload_attachment) to include. Uploading requires a Pro account.
correlation_idNoYour own id, echoed back unchanged on read.
ack_timeout_secondsNoOptional acknowledgement deadline in seconds.

Output Schema

NameRequiredDescriptionDefault
resultYesA privacy-minimized, chainable PingRoom notification result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / replace_key / description
      Previous value: -"Your own handle for \"the ping I keep updating\" (1 to 64 characters: letters, digits and . _ : -). A send with a replace_key replaces your earlier ping with the same key in the same room, instead of sending a new one, while that ping is under 24 hours old, replaced fewer than 20 times and replaceable (see replace_notification); the answer is then 200 with the same id and replaced: true. Otherwise a new ping is sent and keeps the key. A send that asks for something a replacement cannot do (requires_ack, is_urgent, attachment_ids, tags, action_number, or a different correlation_id, reply_to or action_icon) always sends a new ping."New value: +"Your own handle for \"the ping I keep updating\" (1 to 64 characters: letters, digits and . _ : -). Only on a server that has replacing turned on, which is when replace_notification is in your tool list: there a send with a replace_key replaces your earlier ping with the same key in the same room, instead of sending a new one, while that ping is under 24 hours old, replaced fewer than 20 times and replaceable (see replace_notification); the answer is then 200 with the same id and replaced: true. Otherwise, and always while replace_notification is not listed, a new ping is sent and keeps the key. A send that asks for something a replacement cannot do (requires_ack, is_urgent, attachment_ids, tags, action_number, or a different correlation_id, reply_to or action_icon) always sends a new ping."
  2. Changed6 schema fields changed
    • changedInput schema / properties / data / description
      Previous value: -"Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, data.checklist for a checklist, and data.url + data.button_label are reserved for a tappable link ping."New value: +"Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, data.checklist for a checklist, and data.url + data.button_label are reserved for a tappable link ping. data.actions is reserved for up to 3 buttons."
    • addedInput schema / properties / data / properties / actions
      Added value: +{
      +  "description": "Reserved: up to 3 buttons on the notification and the ping's card. open_url opens an https link (the app shows its host); webhook makes PingRoom POST a signed notification.action event to your https URL when a recipient taps it (once per person, for 24 hours; the room owner must be Pro). Not in public or personal rooms, not with requires_ack. The answer carries action_signing_secret to verify deliveries with. A label may not contain a web address or domain, or copy one of PingRoom's own buttons.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "body": {
      +        "description": "webhook only: a JSON object (at most 1024 bytes) echoed back to your URL as `body` on every tap. Never shown to recipients.",
      +        "maxProperties": 10,
      +        "type": "object"
      +      },
      +      "id": {
      +        "description": "Your id for the button, unique on the ping; defaults to a1, a2, a3.",
      +        "pattern": "^[a-z0-9_-]{1,24}$",
      +        "type": "string"
      +      },
      +      "label": {
      +        "description": "Button text.",
      +        "maxLength": 26,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "style": {
      +        "enum": [
      +          "default",
      +          "primary",
      +          "danger"
      +        ],
      +        "type": "string"
      +      },
      +      "type": {
      +        "enum": [
      +          "open_url",
      +          "webhook"
      +        ],
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "https only, a public hostname (punycode for an internationalized one), no user name or password. A webhook URL takes no port.",
      +        "format": "uri",
      +        "maxLength": 2048,
      +        "pattern": "^https://",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "label",
      +      "type",
      +      "url"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 3,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedOutput schema / properties / result / properties / action_signing_secret
      Added value: +{
      +  "description": "broadcast with a webhook button: the secret every delivery of this ping's buttons is signed with (X-PingRoom-Signature-V2). Returned only here; keep it to verify the deliveries.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / result / properties / actions
      Added value: +{
      +  "description": "The buttons the sender put on the ping: {id, label, type, style}, plus url and host for an open_url button. A webhook button never shows where it goes. Present only on a ping with buttons.",
      +  "items": {
      +    "type": "object"
      +  },
      +  "maxItems": 3,
      +  "type": "array"
      +}
    • addedOutput schema / properties / result / properties / actions_expire_at
      Added value: +{
      +  "description": "When the ping's buttons stop running (24 hours after it was sent).",
      +  "type": "string"
      +}
    • addedOutput schema / properties / result / properties / withdrawn_at
      Added value: +{
      +  "description": "When the sending agent took the ping back with withdraw_notification (null when never). The ping stays in the room's history with its text. Present on reads; on a list or the broadcast answer only once the ping has been withdrawn.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  3. Changed5 schema fields changed
    • addedInput schema / properties / replace_key
      Added value: +{
      +  "description": "Your own handle for \"the ping I keep updating\" (1 to 64 characters: letters, digits and . _ : -). A send with a replace_key replaces your earlier ping with the same key in the same room, instead of sending a new one, while that ping is under 24 hours old, replaced fewer than 20 times and replaceable (see replace_notification); the answer is then 200 with the same id and replaced: true. Otherwise a new ping is sent and keeps the key. A send that asks for something a replacement cannot do (requires_ack, is_urgent, attachment_ids, tags, action_number, or a different correlation_id, reply_to or action_icon) always sends a new ping.",
      +  "maxLength": 64,
      +  "minLength": 1,
      +  "pattern": "^[A-Za-z0-9._:-]+$",
      +  "type": "string"
      +}
    • addedInput schema / properties / tags
      Added value: +{
      +  "description": "Up to 10 labels to file this ping under, so history can later be filtered by one (list_notifications and wait_for_notification take a tag). Each is 1 to 32 characters: lowercase letters, digits, \"-\" and \"_\", starting with a letter or digit. Trimmed, lowercased and de-duplicated for you.",
      +  "items": {
      +    "pattern": "^\\s*[A-Za-z0-9][A-Za-z0-9_-]{0,31}\\s*$",
      +    "type": "string"
      +  },
      +  "maxItems": 10,
      +  "type": "array"
      +}
    • addedOutput schema / properties / result / properties / edited_at
      Added value: +{
      +  "description": "When the sender last replaced the ping's text (null when never). Present on reads; on a list or the broadcast answer only once the ping has been replaced.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / result / properties / replaced
      Added value: +{
      +  "description": "broadcast with a replace_key: true when the send replaced your earlier ping (same id) instead of sending a new one.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / result / properties / tags
      Added value: +{
      +  "description": "Labels the sender put on the ping, sorted alphabetically; [] when none.",
      +  "items": {
      +    "maxLength": 32,
      +    "type": "string"
      +  },
      +  "maxItems": 10,
      +  "type": "array"
      +}
  4. Changed1 schema field changed
    • changedInput schema / properties / title / description
      Previous value: -"Optional headline. Defaults to the room name."New value: +"Optional headline. Defaults to the room name, which someone else's personal room always keeps."
  5. Changed1 schema field changed
    • addedOutput schema / properties / result / properties / checklist_state
      Added value: +{
      +  "description": "Present once an item of data.checklist is checked: ticks[] of {index, checked_at, checked_by.display_name}. A checked item stays checked.",
      +  "type": "object"
      +}
  6. Changed1 schema field changed
    • changedInput schema / properties / data / properties / checklist / description
      Previous value: -"A short checklist the room can tick through, e.g. a shopping list. Ticks are kept on each viewer's device, not shared."New value: +"A short checklist the room can tick through, e.g. a shopping list. The room ticks it together: a checked item is checked for everyone, cannot be unchecked, and alerts the other recipients."
  7. Changed2 schema fields changed
    • changedInput schema / properties / data / description
      Previous value: -"Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, and data.url + data.button_label are reserved for a tappable link ping."New value: +"Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, data.checklist for a checklist, and data.url + data.button_label are reserved for a tappable link ping."
    • addedInput schema / properties / data / properties / checklist
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "A short checklist the room can tick through, e.g. a shopping list. Ticks are kept on each viewer's device, not shared.",
      +  "properties": {
      +    "items": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "text": {
      +            "description": "One checklist item.",
      +            "maxLength": 80,
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "text"
      +        ],
      +        "type": "object"
      +      },
      +      "maxItems": 25,
      +      "minItems": 1,
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "items"
      +  ],
      +  "type": "object"
      +}
  8. Changed1 schema field changed
    • changedInput schema / properties / is_urgent / description
      Previous value: -"Deliver time-sensitive so the ping breaks through Focus / Do Not Disturb. Independent of requires_ack: urgent affects delivery only and asks nothing of the recipient."New value: +"Deliver time-sensitive so the ping breaks through Focus / Do Not Disturb and reaches members who muted the room or you (a block still wins). Independent of requires_ack: urgent affects delivery only and asks nothing of the recipient."
  9. Changed1 schema field changed
    • changedInput schema / properties / action_number / maximum
      Previous value: -4New value: +16
  10. Changed2 schema fields changed
    • addedInput schema / properties / ack_mode
      Added value: +{
      +  "description": "With requires_ack: any (default) resolves on the first confirmation; all waits for every original eligible recipient. Read action_state.confirmed_count and required_count for progress.",
      +  "enum": [
      +    "any",
      +    "all"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / requires_ack / description
      Previous value: -"Keep this ping open until one eligible recipient acknowledges it, and show it as a lock-screen card with an Acknowledge button. Does not raise the interruption level on its own — combine with is_urgent for an ack that also breaks through Focus."New value: +"Keep this ping open until its confirmation rule is met, and show it as a lock-screen card with an Acknowledge button. Does not raise the interruption level on its own — combine with is_urgent for an ack that also breaks through Focus."
  11. Changed1 schema field changed
    • addedOutput schema / properties / result / properties / origin_agent
      Added value: +{
      +  "description": "Present when a connected agent originated the ping: its handle and display name.",
      +  "type": "object"
      +}
  12. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations it discloses a rate limit, the Pro-only restriction in personal rooms, that title/is_urgent/requires_ack are silently ignored there, that it consumes the visitor's two-ping cap, and that checklist ticks are shared and irreversible (read back as checklist_state). These are exactly the non-obvious operational facts an agent needs and none are derivable from the annotations.

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?

It is front-loaded with purpose and wastes no sentences, but the personal-room sentence packs many parenthetical clauses into one long line, making it denser than it needs to be. Still, every clause carries a distinct constraint.

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?

For a 15-parameter tool with nested objects and an output schema, the description covers the highest-risk behavior (personal-room permissions, ignored parameters, ping caps) and defers return shape to the output schema. It says nothing about attachment limits, replace_key interaction, or ack semantics, but those are documented in the schema.

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 the baseline is 3; the description still adds real meaning by explaining the reserved data.checklist.items payload and the checklist_state read-back, information not carried by the schema field text alone. It leaves the other 14 parameters (attachments, replace_key, ack modes, tags) to the schema.

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 first sentence names a specific verb and resource (send a custom ping to a room) plus the scoping constraint (a room the account belongs to). It also carves out a distinct case from the sibling trigger_quick_action, so an agent can tell the two apart 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The definition gives explicit when-to-use conditions for the ambiguous case (someone else's personal room) and names the alternative route: 'otherwise use trigger_quick_action there.' It does not spell out when to prefer a plain ping over requires_ack or other sibling flows, so it stops short of a full routing guide.

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.

Resources