Skip to main content
Glama

test_webhook_endpoint

Idempotent

Queue a synthetic webhook.test delivery (no item) to check the receiver and its signature verification. Queue admission is not HTTP delivery; inspect list_webhook_deliveries. 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

NameRequiredDescriptionDefault
endpoint_idYesWebhook endpoint id (UUID) from list_webhook_endpoints.
idempotency_keyYesA new UUID for this one intent; reuse it only to retry the identical request.
expected_revisionYesThe endpoint's current revision from list_webhook_endpoints; a stale revision is refused so concurrent edits are never overwritten.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / endpoint_id / description
      Added value: +"Webhook endpoint id (UUID) from list_webhook_endpoints."
    • addedInput schema / properties / expected_revision / description
      Added value: +"The endpoint's current revision from list_webhook_endpoints; a stale revision is refused so concurrent edits are never overwritten."
    • addedInput schema / properties / idempotency_key / description
      Added value: +"A new UUID for this one intent; reuse it only to retry the identical request."
  2. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare idempotentHint=true, readOnlyHint=false, destructiveHint=false and openWorldHint=true, but the description adds genuinely new context: the required webhook.manage permission, the asynchronous queue-vs-HTTP distinction, the tenant/agent/Live-Sandbox authorization model inherited from /api/v1/webhooks/endpoints, and an idempotent-retry protocol. That is materially more than the annotations convey.

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-loaded with the purpose and the queue-vs-delivery caveat, and every sentence carries operational content. It is dense with five clauses, but none are pure filler; the docs URL and authorization-model sentence are slightly less essential than the rest.

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 no explanation, and the three parameters are fully documented in the schema. The description closes the remaining gaps an agent would care about: permission requirement, async semantics, retry safety, and where to observe the result.

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 baseline is 3; the description adds a small amount beyond the schema by framing idempotency_key reuse in terms of 'an uncertain mutation' and pointing endpoint_id back to list_webhook_endpoints. It does not explain expected_revision's optimistic-concurrency role, which the schema already covers well.

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?

Precise verb+resource+scope: 'Queue a synthetic webhook.test delivery (no item) to check the receiver and its signature verification.' The '(no item)' qualifier implicitly separates it from the sibling test_webhook_endpoint_with_sample, and 'synthetic ... delivery' separates it from create_webhook_endpoint.

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

Usage Guidelines5/5

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

States the when-not explicitly ('Queue admission is not HTTP delivery') and routes the agent to the correct verification path via list_webhook_deliveries. It also gives retry guidance ('Reuse the exact idempotency_key and input after an uncertain mutation'), so the agent knows both the trigger and the follow-up tool.

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.