Skip to main content
Glama

Toggle Transactional Webhook (preview, then confirm)

toggle_transactional_webhook
DestructiveIdempotent

Enable or disable a transactional (Email API) webhook. A disabled webhook stops sending events until enabled again; needs webhook_id and active. Pausing (active: false) needs confirm: true after a preview. Enabling is refused if the webhook's URL can't be reached.

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": {
      "webhook_id": "<webhook_id>",
      "active": "<active>"
    },
    "name": "toggle_transactional_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
activeYesSet true to activate or false to deactivate
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_runNoShow what would change without changing anything
webhook_idYesTransactional webhook ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is known. The description adds genuine value beyond that: what a disabled state actually does (stops sending events until re-enabled) and the external precondition that enabling fails if the webhook URL is unreachable. It omits mention of the dry_run path and whether the confirm gate applies symmetrically to enabling.

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?

Three tight sentences with no filler, leading with the action and following with state consequences and the confirmation requirement. Nothing is redundant, though the unreachable-URL caveat is appended after the confirm rule rather than grouped with the enabling path it belongs to.

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 destructive mutation with full annotation coverage and no output schema, the description covers effect, precondition and confirmation flow adequately. The remaining gap is small but real: dry_run is an available escape hatch that the description never surfaces, which an agent could easily miss when deciding how to preview.

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 description coverage is 100%, so webhook_id, active, confirm and dry_run are all documented in the schema itself; baseline is 3. The description reinforces the required parameters and the confirm-after-preview contract but adds no syntax, format, or constraint detail beyond what the schema already says, and it never mentions dry_run.

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?

States a specific verb+resource pair ('Enable or disable a transactional (Email API) webhook'), and the 'transactional (Email API)' qualifier separates it from the sibling toggle_webhook. It does not explicitly name toggle_webhook or update_transactional_webhook as the non-equivalent alternatives, so sibling differentiation is implied by resource naming rather than spelled out.

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 clear operational context: pausing requires confirm: true after a preview, and enabling is refused when the URL is unreachable. What's missing is guidance on when to reach for this versus toggle_webhook or update_transactional_webhook, but the workflow for the primary case is unambiguous.

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.