Skip to main content
Glama

Add Suppressions (preview, then confirm)

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. First observed

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, but the description adds real behavioral context beyond them: the batch is all-or-nothing so one bad address rejects everything, the block is persistent for future sends, and user confirmation is expected before committing. That is exactly the extra layer annotations cannot express.

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 core action and the most dangerous misconception (it will not stop Marketing Platform campaigns) before the scope taxonomy. It is dense and every sentence carries information, though the scope explanation partially repeats what the schema property descriptions already say.

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?

For a destructive, open-world mutation with no output schema, the description covers effect, persistence, scope semantics, failure mode, and the safe preview-then-confirm protocol. An agent has everything needed to call it correctly and responsibly.

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 baseline is 3, and the description earns above that by explaining the failure semantics of the emails batch (all-or-nothing) and reinforcing the confirm/dry_run workflow rather than just restating the enum. The scope definitions largely duplicate the schema text, which caps it below 5.

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?

Specific verb+resource ('Add recipients to the API Platform suppression list') with the effect stated ('rejected on future API Platform sends'). It explicitly carves out what it does NOT do ('does NOT stop Marketing Platform campaigns') and names the sibling that handles that case (update_contact), so an agent can separate it from the many other add_* and contact 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?

Gives explicit when-to-use (API Platform sends), when-not-to-use (Marketing Platform campaigns), and the alternative path (unsubscribe via update_contact or panel import). It also prescribes the operating procedure: preview with dry_run/omitted confirm, show the user, then confirm.

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.