Skip to main content
Glama

add_suppressions

DestructiveIdempotent

Add recipients to the API Platform (Email API / SMTP) suppression list so they are rejected on future API Platform sends. It does NOT stop Marketing Platform campaigns: to stop campaigns reaching an address, unsubscribe the contact (update_contact) or import it as suppressed in the panel. Scopes: global (default) blocks every API Platform send; marketing blocks only PROMOTIONAL Email API messages (metadata campaignType PROMOTIONAL), NOT Marketing Platform campaigns; transactional blocks only transactional (non-promotional) API Platform messages. The request is all-or-nothing: an invalid address rejects the whole batch. This blocks future mail to those addresses — confirm with the user first. Set dry_run: true to validate without changing anything.

Input Schema

NameRequiredDescriptionDefault
scopeNoScope for the whole batch: global (default, every API Platform send), marketing (promotional Email API messages only, not Marketing Platform campaigns), or transactional
emailsYesEmail addresses to suppress
confirmNoMust be true to make the change. Leave it out first to get a preview, show it to the user, and ask them to confirm
dry_runNoValidate the addresses and show what would be suppressed without changing anything

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / confirm
      Added value: +{
      +  "description": "Must be true to make the change. Leave it out first to get a preview, show it to the user, and ask them to confirm",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / emails / description
      Previous value: -"Email addresses to suppress,required"New value: +"Email addresses to suppress"
    • addedInput schema / properties / scope / enum
      Added value: +[
      +  "global",
      +  "marketing",
      +  "transactional"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / scope / description
      Previous value: -"Scope for the whole batch: global (default), marketing, or transactional"New value: +"Scope for the whole batch: global (default, every API Platform send), marketing (promotional Email API messages only, not Marketing Platform campaigns), or transactional"
  3. Changed2 schema fields changed
    • removedInput schema / properties / api_key
      Removed value: -{
      -  "description": "MailerCloud API key",
      -  "type": "string"
      -}
    • addedInput schema / properties / dry_run
      Added value: +{
      +  "description": "Validate the addresses and show what would be suppressed without changing anything",
      +  "type": "boolean"
      +}
  4. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is known; the description adds genuinely new behavior: the batch is all-or-nothing and one invalid address rejects everything, the effect is on future sends only, and the agent must confirm with the user first. It also disambiguates the three scope values in terms of which downstream traffic they actually block.

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 purpose, then the critical exclusion, then scopes, batch semantics, and the safety warning — every sentence carries information. It is dense and slightly repeats the scope semantics already present in the enum descriptions, so not flawless, but no filler.

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?

With no output schema and four parameters (one enum), the description supplies everything an agent needs: blast radius, scope distinctions, batch atomicity, the concurrency/confirmation protocol, and a validation escape hatch via dry_run.

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 coverage is 100%, so the baseline is 3; the description still earns credit by explaining that 'marketing' scope covers only PROMOTIONAL Email API traffic and explicitly not Marketing Platform campaigns, which the schema's short enum text does not make as clear. The confirm/dry_run workflow also gets behavioral context (preview, then confirm) beyond the schema's one-liners.

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 + resource (add recipients to the API Platform suppression list) and immediately draws the boundary that matters: it does NOT stop Marketing Platform campaigns. An agent can distinguish it from list_suppressions and reactivate_suppression without opening any 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?

Explicitly names the conditions that select a different tool: to stop campaigns, use update_contact (unsubscribe) or import as suppressed in the panel. It also prescribes the call sequence (dry_run first, confirm after user approval), leaving nothing to inference.

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