Skip to main content
Glama

Set my unsubscribe page name and provider webhooks

suppression_settings
DestructiveIdempotent

Set your unsubscribe-list's page name (site_name), the inbox for suppression events, and the bounce and complaint webhooks of your providers: resend {signing_secret}, sendgrid {public_key}, ses {topic_arn}, postmark true (null turns resend, sendgrid or ses off; postmark false). Fields left out stay. The answer has each provider's webhook_url: set it in that provider once, and its bounces and complaints join the list by themselves, with no suppression_add. Postmark's Basic auth password is shown only when you turn it on.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "providers": {
        "resend": {
          "signing_secret": "whsec_EXAMPLEexampleEXAMPLE"
        }
      },
      "instance_id": "sup_exampleexampleexample2"
    },
    "name": "suppression_settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
providersNoThe providers to set up.
site_nameNoThe name your unsubscribe page shows (a plain name, null clears it).
instance_idYesUtility instance id from buy or list_utilities.
passport_tokenNoYour amp_ token, only if you have no app sign-in and cannot send a header.
inbox_instance_idNoOne of your owner's webhook inboxes for suppression events (null: none).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "instance_id": "sup_exampleexampleexample2",
      +    "providers": {
      +      "resend": {
      +        "signing_secret": "whsec_EXAMPLEexampleEXAMPLE"
      +      }
      +    }
      +  }
      +]
    • changedInput schema / properties / passport_token / description
      Previous value: -"Your amp_ token, only if your app has no sign-in and cannot send it as an Authorization header."New value: +"Your amp_ token, only if you have no app sign-in and cannot send a header."
    • addedInput schema / properties / providers / properties / postmark / description
      Added value: +"true turns on Postmark's webhook (the answer shows its Basic auth password; send true again to see it again); false turns it off."
    • changedInput schema / properties / providers / properties / resend / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "signing_secret": {
      -        "maxLength": 300,
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "signing_secret"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "signing_secret": {
      +        "description": "The whsec_... signing secret of your Resend webhook.",
      +        "maxLength": 300,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "signing_secret"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / providers / properties / resend / description
      Added value: +"Resend's bounce and complaint webhook; null turns it off."
    • changedInput schema / properties / providers / properties / sendgrid / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "public_key": {
      -        "maxLength": 400,
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "public_key"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "public_key": {
      +        "description": "The verification key of SendGrid's Signed Event Webhook.",
      +        "maxLength": 400,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "public_key"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / providers / properties / sendgrid / description
      Added value: +"SendGrid's Signed Event Webhook; null turns it off."
    • changedInput schema / properties / providers / properties / ses / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "topic_arn": {
      -        "maxLength": 300,
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "topic_arn"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "topic_arn": {
      +        "description": "The ARN of the SNS topic of your SES bounces and complaints (arn:aws:sns:...).",
      +        "maxLength": 300,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "topic_arn"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / providers / properties / ses / description
      Added value: +"Amazon SES through an SNS topic; null turns it off."
  2. Changed4 schema fields changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / passport_token / description
      Previous value: -"Your amp_ token, only if your client cannot send it as an Authorization header; leave it out when your MCP app signed in."New value: +"Your amp_ token, only if your app has no sign-in and cannot send it as an Authorization header."
    • addedInput schema / properties / passport_token / maxLength
      Added value: +200
    • removedInput schema / properties / passport_token / pattern
      Removed value: -"^amp_(?:s_)?[A-Za-z0-9_-]{43}$"
  3. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true; the description meaningfully adds patch semantics ('Fields left out stay'), the null-to-disable convention per provider, and that Postmark's Basic auth password is only revealed when turning it on. It stops short of explaining what the destructive aspect actually is (e.g. that null removes a provider's existing webhook configuration).

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-loads the three things it configures, then compresses provider specifics into a compact list with no filler sentences. The brace/boolean shorthand ('postmark true (null turns ... off; postmark false)') is dense and takes a second pass to parse, which slightly hurts readability.

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?

Covers the important return-side behavior (the answer carries each provider's webhook_url and Postmark's password) despite there being no output schema, and handles the nested provider objects and partial-update semantics. Auth details such as when passport_token is needed are left entirely to the schema, and the destructive scope is not fully spelled out.

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 would be 3, but the description adds real meaning on top: the brace notation maps each provider to its required credential (resend→signing_secret, sendgrid→public_key, ses→topic_arn, postmark→boolean), spells out null/false disable behavior, and states that omitted fields are preserved.

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 three concrete resources: the unsubscribe page name (site_name), the suppression-events inbox, and the bounce/complaint webhooks of Resend, SendGrid, SES and Postmark. It also explicitly disambiguates from the sibling suppression_add by noting that configured bounces and complaints join the list 'by themselves, with no suppression_add'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear context for use — wiring provider webhooks so suppression events arrive automatically rather than being added manually — and explains the setup step of copying webhook_url into each provider once. It does not state explicit when-not conditions or point at alternatives for the page-name/inbox portion.

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.