Skip to main content
Glama
arbengine

mailbox-mcp

create_webhook_endpoint

Idempotent

Create a webhook: name, public HTTPS URL, events (inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched) and optional keyword rules (literal terms, any/all, exclusions).

Instructions

Create a webhook: name, public HTTPS URL, events (inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched) and optional keyword rules (literal terms, any/all, exclusions). Active on save. Returns the whsec_ signing secret once; hand it only to the operator's secure configuration, never logs or mail content. Requires explicit user intent for the URL. Agent keys must use their own agent_id and environment; member keys may use agent_id:null for account scope. Requires webhook.manage. Uses the same bounded control plane and tenant/agent/Live-Sandbox authorization as /api/v1/webhooks/endpoints. Reuse the exact idempotency_key and input after an uncertain mutation. Webhook docs: https://mailbox.bot/docs/webhooks.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesPublic HTTPS URL on port 443 (no credentials, fragment or private host) that receives the signed POSTs. Set or change it only on the operator's explicit instruction.
nameYesLabel shown in the dashboard and delivery log.
rulesYesUp to 10 keyword rules, each with a unique id: source (envelope, letter for the contents, or any), match (any or all), 1–20 terms and optional exclude_terms. inbound.keywords_matched fires when a rule matches.
agent_idYesAgent keys: your own agent id. Member keys: an agent id, or null for account scope.
environmentYeslive or test. Agent keys must use their own environment; an endpoint only receives events from its environment.
event_typesYesEvents to deliver (1–16, unique): inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched.
idempotency_keyYesA new UUID for this one intent; reuse it only to retry the identical request.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.3

TDQS

A4.6/5.0
Behavior5/5

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

Annotations cover the safety profile (non-readOnly, non-destructive, idempotent, open-world). The description adds value beyond them: the whsec_ signing secret is returned exactly once and must never be logged or mailed, the endpoint is active on save, and permission/tenant/agent/Live-Sandbox authorization is spelled out. This is exactly the kind of context annotations cannot carry.

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?

Dense but front-loaded: purpose first, then secret-handling warning, then authorization, then retry guidance, then docs link. The event list is duplicated between the description and the schema's event_types, which is a small waste, but every other clause earns its place.

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?

An output schema exists, so return values need not be explained, yet the description still flags the one-time whsec_ secret, which is critical to handling the response correctly. Permission requirements, idempotency behavior, and environment scoping are all present, so an agent has everything needed to invoke this mutation safely.

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 reinforces non-obvious semantics: which key type may set agent_id:null, that agent keys must match their own environment, that an endpoint only receives events from its environment, and the meaning of the keyword rule fields (terms, any/all, exclusions). It adds mild but real value on top of the schema.

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?

Opens with a specific verb+resource ('Create a webhook') and enumerates the exact configuration surface (name, HTTPS URL, event types, keyword rules). An agent can immediately distinguish it from update_webhook, list_webhook_endpoints, rotate_webhook_endpoint_secret, and test_webhook_endpoint in the sibling set.

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 preconditions and constraints: the URL requires explicit user intent, agent keys vs member keys dictate agent_id, and webhook.manage is required. It also tells the agent how to retry uncertain mutations with the same idempotency_key. It stops short of explicitly naming sibling alternatives, but the context is unambiguous.

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