Skip to main content
Glama
SetLuca

SetLuca

Official

Cancel a broadcast

luca_broadcasts_cancel
DestructiveIdempotent

Cancel a Luca broadcast in draft, approved, running, paused, or failed status, with an optional reason and idempotency key for safe retries.

Instructions

Cancel a draft, approved, running, paused, or failed broadcast.

Luca operation: POST /api/broadcasts/{id}/cancel 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_cancel"
  }
}

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

A4.9/5.0
Behavior5/5

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

The description adds crucial operational context beyond the annotations, detailing the requirement for an Idempotency-Key for safe retries, required OAuth scopes, and data sensitivity levels.

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?

The structure is highly efficient, grouping the tool's function first, followed by critical technical constraints, and concluding with implementation notes.

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?

Given the complexity of a destructive operation involving multiple workspace overrides and required security scopes, the definition provides all necessary context for a robust invocation.

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?

While schema coverage is moderate, the description adds semantic value by explaining how to handle workspace context and clarifying the purpose of the idempotencyKey logic.

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 specifies exactly which types of broadcasts (draft, approved, running, paused, failed) can be acted upon, which provides clear operational scope and differentiation from creation or launch tools.

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?

By listing all possible statuses that the tool accepts and successfully operates on, it provides comprehensive usage guidance and defines the boundaries of the tool's capability.

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