Skip to main content
Glama
Sign In

flayr

by social.flayr
OverviewDiscussionsAdmin

Pause or stop an ad campaign

ads_campaign_pause

[writes flayr data · write scope] Pauses a live ad campaign on its ad network so it stops spending (action: "pause" or "stop"; both leave it paused). To approve and switch on a proposed campaign use ads_campaign_approve. Confirm with the user first. (Wraps POST /api/v2/ads/campaigns/{id}/pause.)

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": "ads_campaign_pause"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
actionNostop = a pause you mean as final; the network shows paused either way.pause
brandIdNoA brand id (GET /api/v2/brands) or "personal"; default: the key owner's active brand. A brand-bound key is always pinned to its brand; any other value is 403.
idempotencyKeyNoRetrying with the same key never runs the change twice.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Goes beyond the annotations by disclosing the required `write` scope, the fact that this is a 'writes flayr data' operation, the real-world effect (stops ad-network spend), and that `pause` and `stop` are behaviorally identical on the network. It does not say whether a paused campaign can be resumed or what the call returns, which matters for a mutation tool with no output schema.

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?

Front-loaded with the action verb and outcome, followed by the alternative and the confirmation requirement; every sentence carries information. The bracketed scope/endpoint preamble is slightly noisy but useful metadata.

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 mutation tool with no output schema, the description supplies scope, side effect, alternative routing, and a confirmation guardrail. It stops short of describing the response payload or reversibility, which would fully close the loop.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 75% and already documents action, brandId, and idempotencyKey thoroughly. The description's note that both `"pause"` and `"stop"` leave the campaign paused reinforces the enum but adds little beyond it, and it says nothing new about brandId or idempotencyKey.

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?

States a specific verb and resource ('Pauses a live ad campaign on its ad network') plus the concrete outcome ('so it stops spending'), and explicitly distinguishes itself from the sibling ads_campaign_approve, which handles proposed campaigns. An agent can select between the two without opening either schema.

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?

Names the alternative tool and the condition that selects it ('To approve and switch on a proposed campaign use ads_campaign_approve'), and adds an operational precondition ('Confirm with the user first'). Both the when and the when-not are present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All flayr toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources