Skip to main content
Glama
mailbox-mcp

mailbox-mcp

update_webhook

Idempotent

Configure a webhook endpoint URL and event subscriptions to receive real-time mailbox notifications, with optional pause control.

Instructions

Configure webhook endpoint URL and event subscriptions for real-time notifications. Outbound events are mail.pending_approval, mail.submitted, mail.ready, mail.mailed, mail.delivered, mail.failed, and mail.cancelled. Canonical physical-custody events are inbound.received and inbound.scan_available. The endpoint needs HTTPS and a 2xx response within 10 seconds.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "update_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
enabledNoSet to false to pause webhook delivery without removing the URL.
event_typesNoArray of event types to subscribe to (e.g. ["mail.mailed", "inbound.received"]). Empty array disables all events.
webhook_urlNoHTTPS URL that receives webhook POST requests and answers 2xx within 10 seconds.

Output Schema

NameRequiredDescriptionDefault
resultYesWebhook configuration status.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.5
    • changedInput schema / properties / webhook_url / description
      Previous value: -"HTTPS URL to receive webhook POST requests. Must respond with 2xx within 10 seconds."New value: +"HTTPS URL that receives webhook POST requests and answers 2xx within 10 seconds."
  2. Changed1 schema field changedv1.0.3
    • changedInput schema / properties / event_types / description
      Previous value: -"Array of event types to subscribe to (e.g. [\"package.received\", \"mail.status_changed\"]). Empty array disables all events."New value: +"Array of event types to subscribe to (e.g. [\"mail.mailed\", \"inbound.received\"]). Empty array disables all events."
  3. First observedv1.0.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare the mutation is non-destructive and idempotent, so the description is free to add genuinely new behavioral facts: the complete event taxonomy split into outbound mail.* events and canonical inbound.* events, plus delivery requirements (HTTPS, 2xx within 10 seconds). It omits one important behavior for a mutation with zero required parameters — whether omitted fields are preserved or cleared — but does not contradict any annotation.

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?

Four short sentences with the purpose front-loaded and the event taxonomy grouped by outbound vs inbound. Slight redundancy remains where the HTTPS/10-second requirement restates the webhook_url schema description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present and full parameter coverage, most return-value explanation is unnecessary, and the description covers event names and delivery constraints well. What is missing is the partial-update contract: all three parameters are optional, yet the description never says whether calling with only event_types leaves the URL untouched.

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 the schema already explains enabled, event_types, and webhook_url, including the empty-array-disables-events semantics and the HTTPS/2xx constraint. The description's event list duplicates the schema's example rather than adding format or validation detail, so baseline 3 applies.

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?

The description names a specific verb and resource ('Configure webhook endpoint URL and event subscriptions') and states the outcome (real-time notifications). However, it never distinguishes this tool from close siblings like update_webhook_endpoint, create_webhook_endpoint, or update_webhook_endpoint's secret rotation, so an agent comparing the two 'update' tools gets no disambiguation.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance, and no alternative tool is named despite several near-identical siblings. The event catalog hints at what the tool affects, but selection between update/create/list/test endpoints is left entirely to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.