Skip to main content
Glama

Update campaign

update_campaign
Destructive

Change a campaign: its title, description, message, schedule, audience, business-hours rule, the speaker it shows (sender_name, use_bot_identity) or whether it is enabled. Only the fields you pass change.

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": {
      "campaign_id": "<campaign_id>"
    },
    "name": "update_campaign"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNo
enabledNo
messageNo
audienceNoOne-off campaigns only: the labels whose contacts receive the message.
campaign_idYesCampaign id as returned by list_campaigns.
descriptionNo
sender_nameNoWebsite campaigns only: the name the widget card shows as the speaker (for example "Ana"). Null clears it.
scheduled_atNo
use_bot_identityNoWebsite campaigns only: speak as the inbox's AI agent, with its name and picture. Falls back to sender_name when the inbox has no AI agent.
trigger_only_during_business_hoursNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / sender_name
      Added value: +{
      +  "description": "Website campaigns only: the name the widget card shows as the speaker (for example \"Ana\"). Null clears it.",
      +  "maxLength": 40,
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / use_bot_identity
      Added value: +{
      +  "description": "Website campaigns only: speak as the inbox's AI agent, with its name and picture. Falls back to sender_name when the inbox has no AI agent.",
      +  "type": "boolean"
      +}
  2. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is covered. The description adds genuine behavioral value with the PATCH semantic ("Only the fields you pass change"), which tempers the destructive read. It stops short of explaining what is actually destroyed — notably that passing null to sender_name clears the speaker — and says nothing about irreversibility or permissions.

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?

Two tight sentences: the field inventory first, the partial-update contract second. No filler, no restatement of the title, and the most decision-relevant detail (only passed fields change) is placed where it is read.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, non-idempotent 10-parameter mutation with no output schema, the description covers the field surface and patch semantics adequately. It leaves out the campaign-type applicability that the sibling tools imply and does not warn about null-clearing behavior or reversibility, which are the residual risks an agent would want flagged.

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 only 40% schema description coverage across 10 parameters, the description carries real weight, and it does map nine of the ten fields to plain-language concepts (schedule→scheduled_at, business-hours rule→trigger_only_during_business_hours). It also explains that sender_name and use_bot_identity control "the speaker it shows" and how they relate, which the schema documents only in isolation. It omits the campaign-type constraints on audience and sender_name, but those are covered in 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?

The description uses a specific verb+resource ("Change a campaign") and enumerates the mutable surface: title, description, message, schedule, audience, business-hours rule, speaker identity, and enabled flag. An agent knows exactly what this tool mutates. It does not, however, distinguish itself from the sibling suite (update_voice_campaign, update_whatsapp_campaign), leaving the campaign-type scoping implicit until the agent reads the schema.

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?

"Only the fields you pass change" gives a clear partial-update contract, which is real usage guidance. But there is no statement of when to prefer this tool over update_voice_campaign or update_whatsapp_campaign, nor any prerequisite (permissions, campaign state) for calling it. Usage is inferable rather than stated.

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