Skip to main content
Glama

Publish Live Status

live_status
DestructiveIdempotent

Start, update, or end a live progress card on the room members' lock screen (an iOS Live Activity / Android live update). Reuse the same correlation_id for every ping of one stream: the first ping starts the card and sends one alert, further "running" pings move it silently, and the first "done"/"failed" sends one completion alert and ends it. Free accounts get a small number of NEW streams per day; updates and the final ping of an open stream are never charged; a first ping that is already "done"/"failed" counts as a new stream.

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>",
      "correlation_id": "<correlation_id>",
      "live_status": "<live_status>"
    },
    "name": "live_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataNoArbitrary structured context (max 25 keys / 8KB), returned on read surfaces after connector privacy filtering. Do not put secrets in data.
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. Set by the ping that starts the stream; later pings of the same stream may repeat or omit them and never change them.
titleNoCard title. Every template takes at most 40 characters and refuses a longer one; only the claim template takes up to 120 (its request text), which is why this schema allows 120. Defaults to the selected quick action's label.
actionNoQuick-action slot to attribute the stream to (supplies the icon and sound).
invite_codeYesRoom invite code.
live_statusYesThe live card's state. Only state is required.
requires_ackNoAdd an Acknowledge button; the first eligible member to tap resolves it for everyone. Does not raise the interruption level — set category "alert" for a time-sensitive start.
correlation_idYesThe stream key. Reuse it on every ping of the same stream.
ack_timeout_secondsNoOptional acknowledgement deadline in seconds.

Output Schema

NameRequiredDescriptionDefault
resultYesPurpose-built PingRoom result with credential and account fields removed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • addedInput schema / properties / live_status / properties / current_segment
      Added value: +{
      +  "description": "Progress template only: how many segments are filled, 0..segments (422 invalid_current_segment otherwise). When progress is omitted the server derives progress as current_segment / segments.",
      +  "maximum": 20,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / live_status / properties / delta
      Added value: +{
      +  "description": "Value template only: the change, e.g. \"+3.2%\".",
      +  "maxLength": 12,
      +  "type": "string"
      +}
    • addedInput schema / properties / live_status / properties / segments
      Added value: +{
      +  "description": "Progress template only: draw the bar in this many equal segments. Cannot change once set (a different value on a running ping is rejected with 422 segments_immutable).",
      +  "maximum": 20,
      +  "minimum": 2,
      +  "type": "integer"
      +}
    • addedInput schema / properties / live_status / properties / started_at
      Added value: +{
      +  "description": "Timer template only: epoch seconds the timer counts up from. Defaults to now on the first ping and cannot change afterwards (422 started_at_immutable on a running ping). The card ticks by itself; send a message update at least every 15 minutes or the stream is ended as stale. A done/failed ping freezes the card at the final elapsed time.",
      +  "maximum": 4102444800,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / live_status / properties / stats
      Added value: +{
      +  "description": "4 to 8 {label,value} pairs for the stats template, drawn as two rows. Required on the first ping of a stats stream (422 stats_required). Labels and values may change on later pings; omit the field to keep the stored list. When message is omitted the server writes \"Label Value · Label Value\" so an older app reads it.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "label": {
      +        "maxLength": 24,
      +        "type": "string"
      +      },
      +      "value": {
      +        "maxLength": 24,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "label",
      +      "value"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 8,
      +  "minItems": 4,
      +  "type": "array"
      +}
    • changedInput schema / properties / live_status / properties / template / description
      Previous value: -"Which layout the OS renders. Fixed at stream creation. \"claim\" is a \"Who's on it?\" request one member takes on (private rooms only): its text is title (or message), up to 120 characters, an optional deadline_at is at most 8 hours away, and it then moves only through live_claim, or a done/failed ping from you that finishes or cancels it."New value: +"Which layout the OS renders. Fixed at stream creation. \"timer\" counts up from started_at, \"value\" shows one prominent value and \"stats\" shows 4 to 8 labelled values; an app that predates them shows the plain status card (title and message). \"claim\" is a \"Who's on it?\" request one member takes on (private rooms only): its text is title (or message), up to 120 characters, an optional deadline_at is at most 8 hours away, and it then moves only through live_claim, or a done/failed ping from you that finishes or cancels it."
    • changedInput schema / properties / live_status / properties / template / enum
      Previous value: -[
      -  "status",
      -  "steps",
      -  "progress",
      -  "metrics",
      -  "countdown",
      -  "question",
      -  "matchup",
      -  "claim"
      -]New value: +[
      +  "status",
      +  "steps",
      +  "progress",
      +  "metrics",
      +  "countdown",
      +  "question",
      +  "matchup",
      +  "claim",
      +  "timer",
      +  "value",
      +  "stats"
      +]
    • addedInput schema / properties / live_status / properties / trend
      Added value: +{
      +  "description": "Value template only: the arrow drawn beside delta. Neutral colour: up is not always good.",
      +  "enum": [
      +    "up",
      +    "down",
      +    "flat"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / live_status / properties / value
      Added value: +{
      +  "description": "Value template only: the one prominent value, e.g. \"$12.4k\". Required on the first ping of a value stream (422 value_required).",
      +  "maxLength": 24,
      +  "type": "string"
      +}
    • addedInput schema / properties / live_status / properties / value_label
      Added value: +{
      +  "description": "Value template only: what the value is, e.g. \"Revenue\".",
      +  "maxLength": 24,
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • 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. Set by the ping that starts the stream; later pings of the same stream may repeat or omit them and never change them.",
      +  "items": {
      +    "pattern": "^\\s*[A-Za-z0-9][A-Za-z0-9_-]{0,31}\\s*$",
      +    "type": "string"
      +  },
      +  "maxItems": 10,
      +  "type": "array"
      +}
  3. Changed4 schema fields changed
    • changedInput schema / properties / live_status / properties / template / description
      Previous value: -"Which layout the OS renders. Fixed at stream creation."New value: +"Which layout the OS renders. Fixed at stream creation. \"claim\" is a \"Who's on it?\" request one member takes on (private rooms only): its text is title (or message), up to 120 characters, an optional deadline_at is at most 8 hours away, and it then moves only through live_claim, or a done/failed ping from you that finishes or cancels it."
    • changedInput schema / properties / live_status / properties / template / enum
      Previous value: -[
      -  "status",
      -  "steps",
      -  "progress",
      -  "metrics",
      -  "countdown",
      -  "question",
      -  "matchup"
      -]New value: +[
      +  "status",
      +  "steps",
      +  "progress",
      +  "metrics",
      +  "countdown",
      +  "question",
      +  "matchup",
      +  "claim"
      +]
    • changedInput schema / properties / title / description
      Previous value: -"Card title. Defaults to the selected quick action's label."New value: +"Card title. Every template takes at most 40 characters and refuses a longer one; only the claim template takes up to 120 (its request text), which is why this schema allows 120. Defaults to the selected quick action's label."
    • changedInput schema / properties / title / maxLength
      Previous value: -40New value: +120
  4. Changed1 schema field changed
    • changedInput schema / properties / live_status / properties / steps / description
      Previous value: -"Step labels. Required on the first ping of a steps stream. They cannot change afterwards: a later ping may resend the identical list or omit it, and a different list is rejected with 422 steps_immutable. Send current_step to advance, or start a new stream with a new correlation_id for a different list."New value: +"Step labels. Required on the first ping of a steps stream. They cannot change afterwards: a later ping may resend the identical list or omit it, and a different list on a running ping is rejected with 422 steps_immutable (a done/failed ping ignores it and still ends the stream). Send current_step to advance, or start a new stream with a new correlation_id for a different list."
  5. Changed3 schema fields changed
    • changedInput schema / properties / live_status / properties / deadline_at / description
      Previous value: -"Epoch seconds the countdown template counts down to."New value: +"Epoch seconds the countdown template counts down to. A later ping may move it; duration_seconds then moves by the same amount. Send the absolute new deadline, never a delta."
    • changedInput schema / properties / live_status / properties / duration_seconds / description
      Previous value: -"Original countdown duration in seconds. Set on creation; preserved through updates and completion."New value: +"Countdown duration in seconds. Read from the first ping only (a later ping's own value is ignored); preserved through updates and completion. Moving deadline_at on a later ping changes the stored duration by the same amount."
    • changedInput schema / properties / live_status / properties / steps / description
      Previous value: -"Step labels. Required on the first ping of a steps stream; immutable afterwards."New value: +"Step labels. Required on the first ping of a steps stream. They cannot change afterwards: a later ping may resend the identical list or omit it, and a different list is rejected with 422 steps_immutable. Send current_step to advance, or start a new stream with a new correlation_id for a different list."
  6. Changed1 schema field changed
    • addedInput schema / properties / live_status / properties / duration_seconds
      Added value: +{
      +  "description": "Original countdown duration in seconds. Set on creation; preserved through updates and completion.",
      +  "maximum": 4102444800,
      +  "minimum": 1,
      +  "type": "integer"
      +}
  7. Changed1 schema field changed
    • changedInput schema / properties / action / maximum
      Previous value: -4New value: +16
  8. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations, it discloses alert semantics (exactly one alert on the first ping, silent running updates, exactly one completion alert), billing rules (updates and the closing ping of an open stream are free; a first ping that is already done/failed counts as new), and the 15-minute staleness rule that appears again in started_at. These are exactly the operational facts an agent cannot derive from readOnlyHint/destructiveHint/openWorldHint alone.

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 dense but front-loaded: lifecycle first, then stream keying, then billing. The final billing sentence is long and clause-heavy, but every clause (free updates, free closing ping, done-on-first-ping charging) carries distinct information, so little is wasted.

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 nine-parameter tool with a deeply nested live_status object, an output schema, and full annotation coverage, the description supplies the one thing the structured data cannot: the stream lifecycle model that ties correlation_id, state transitions, alerting, and billing together. An agent can call this correctly without further context.

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 description coverage is 100%, so the schema carries parameter detail and the baseline is 3. The description still adds cross-parameter meaning the schema cannot: that correlation_id is a stream key whose reuse is what makes a ping an update rather than a new stream, and that done/failed on a first ping is billed differently.

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 triple and resource: 'Start, update, or end a live progress card on the room members' lock screen (an iOS Live Activity / Android live update).' That distinguishes it cleanly from the sibling get_live_status (read) and from the claim-specific path it delegates to live_claim.

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?

Usage is spelled out operationally: reuse the same correlation_id for every ping of one stream, and the state enum decides whether the card starts, moves silently, or terminates with a completion alert. It also flags the free-account quota case. It does not contrast with broadcast/ask_question for one-off notifications, so agents must infer that boundary.

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