Skip to main content
Glama
SetLuca

SetLuca

Official

Pause a broadcast

luca_broadcasts_pause
DestructiveIdempotent

Pauses a running broadcast and accepts an optional operator reason to record why it was stopped.

Instructions

Pause a running broadcast with an optional operator reason.

Luca operation: POST /api/broadcasts/{id}/pause Required scopes: broadcasts:write Required OAuth scope: luca:queue_ops; data sensitivity: full_content Requires Idempotency-Key. Provide idempotencyKey for safe retries, or the server will generate one. Use workspaceId or workspaceSlug to override the default workspace configured by environment.

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": {
      "id": "<id>"
    },
    "name": "luca_broadcasts_pause"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
bodyNo
workspaceIdNoOptional Luca workspace id override.
workspaceSlugNoOptional Luca workspace slug override.
idempotencyKeyNoStable key for safe retries. If omitted, the MCP server generates a unique key for this call.

Output Schema

NameRequiredDescriptionDefault
resultYes
provenanceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.4.2
    • addedOutput schema / properties / result / properties / billingPaused
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / result / properties / outcomes
      Added value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "callsBooked": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "replied": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "windowDays": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed3 schema fields changedv0.4.1
    • changedInput schema / required
      Previous value: -[
      -  "id",
      -  "body"
      -]New value: +[
      +  "id"
      +]
    • addedOutput schema / properties / result / properties / retryBlockedReason
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / result / x-luca-redacted-fields
      Previous value: -[
      -  "recipients[].messageBody",
      -  "safetyReport.findings[].evidence",
      -  "sampleMessages[].body",
      -  "segmentSnapshot.excludedRecipients[].displayName",
      -  "segmentSnapshot.leads[].customFields",
      -  "segmentSnapshot.leads[].displayName",
      -  "segmentSnapshot.leads[].messageBody"
      -]New value: +[
      +  "recipients[].messageBody",
      +  "safetyReport.findings[].evidence",
      +  "sampleMessages[].body",
      +  "segmentSnapshot.excludedRecipients[].displayName",
      +  "segmentSnapshot.leads[].customFields",
      +  "segmentSnapshot.leads[].displayName",
      +  "segmentSnapshot.leads[].messageBody",
      +  "segmentSnapshot.leads[].templateMapping",
      +  "segmentSnapshot.leads[].templatePart"
      +]
  3. First observedv0.4.0

TDQS

A3.8/5.0
Behavior4/5

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

Beyond the annotations (destructiveHint=true, idempotentHint=true, openWorldHint=true), the description discloses required scopes, a data-sensitivity level, and the important fact that the server auto-generates an idempotency key when omitted — meaning retries without an explicit key are not guaranteed safe. It does not say what pausing does to in-flight sends or that resume restores state, which is the remaining behavioral gap for a destructive mutation.

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?

The core action is front-loaded in the first sentence and the remaining lines are short, scannable metadata. The 'Luca operation: POST ...' and 'data sensitivity' lines are closer to internal spec-sheet noise than agent-facing guidance, but they cost little space.

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 5-parameter mutation with a nested body and an available output schema, the definition covers endpoint, auth scopes, idempotency, and workspace resolution. The missing piece is lifecycle context — how pause relates to resume/cancel and what happens to recipients already in flight — given destructiveHint=true.

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?

With 60% schema coverage, the description compensates well: it clarifies that 'reason' is an optional operator note, explains the idempotencyKey fallback behavior, and states that workspaceId/workspaceSlug override the environment-configured default workspace. Only the required 'id' parameter is left to the schema itself.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

'Pause a running broadcast with an optional operator reason' gives a specific verb and resource with the scope of the action. It never contrasts itself with adjacent operations such as luca_broadcasts_cancel or luca_broadcasts_resume, so an agent must infer the boundary from the names alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

Usage context is only implied: the tool pausing a *running* broadcast suggests when it applies, and the idempotency/workspace notes give call-time instructions. There is no explicit when-not-to-use guidance and no pointer to resume or cancel as alternatives, which matters for a group of closely related broadcast lifecycle tools.

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