Skip to main content
Glama

Update Transactional Webhook

update_transactional_webhook
DestructiveIdempotent

Update a transactional (Email API) webhook. Only the fields given (name, url, events) are changed: the tool reads the webhook first and resends its current values for the rest, since all three are needed. events replaces the current set. Use toggle_transactional_webhook to enable or disable. Set dry_run: true to see the merged values that would be sent.

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>"
    },
    "name": "update_transactional_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoNew webhook URL (HTTPS, public host)
nameNoNew webhook name
eventsNoEvents to subscribe to (replaces the current set)
dry_runNoValidate and show what would change without changing anything
webhook_idYesTransactional webhook ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/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, yet the description still adds the non-obvious mechanism: the tool reads the webhook first and resends current values so partial updates don't blank fields. It also discloses that events replaces rather than appends, which is exactly the kind of surprise an agent must know before a destructive write.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four tight sentences, front-loaded with purpose, then mutation semantics, then the sibling alternative, then the dry-run tip. Every clause carries information; nothing is repeated filler.

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 partial-update tool with no output schema, the description covers what changes, what is preserved, how to preview, and where to go for toggling. Minor gaps remain around failure behavior (e.g., invalid URL or event values) and whether dry_run reports validation errors, but nothing essential is missing.

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, but the description adds genuine meaning by framing url/name/events as the only mutable fields and clarifying the read-merge-send behavior behind that. The dry_run and events semantics are partly redundant with the schema's own descriptions, keeping this from a 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?

States a specific verb and resource ("Update a transactional (Email API) webhook") and immediately scopes it to the transactional variant, distinguishing it from the plain update_webhook and create_transactional_webhook siblings. An agent can pick this tool without opening another schema.

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?

Explicitly routes enable/disable work to toggle_transactional_webhook and recommends dry_run: true for previewing, which is real when-to-use guidance. It never explicitly contrasts with update_webhook (the non-transactional sibling), but the resource naming largely covers that.

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.