Skip to main content
Glama

webhook_test

Verify a registered webhook by firing a synthetic event through it. Uses the same delivery path as real events to confirm correct wiring.

Instructions

Fire a synthetic event through a registered webhook to verify it's wired correctly. Goes through the same HTTPS POST + HMAC + retry + circuit-breaker path as a real delivery — if the receiver doesn't see this event, it won't see real ones either. Off by default — requires OMNIFOCUS_WEBHOOKS_ENABLED=1. Do NOT use this for load testing — circuit-breaker counters apply to synthetic events too. Returns { name, delivered: true } on dispatch success, { name, error } when the webhook is not registered. Note: 'delivered' means the dispatcher attempted delivery; the receiver's actual response is not surfaced (per ADR-0016 §4e: failures log to stderr, never throw upward). Side effects: makes one outbound HTTPS POST to the registered URL with a synthetic event payload. Example: webhook_test({ name: "slack-billing" })

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName of the registered webhook to fire a synthetic event through.
Behavior5/5

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

No annotations exist, so description bears full burden. It discloses HTTPS POST with HMAC/retry/circuit-breaker, off-by-default, side effects (outbound POST), return values, and that 'delivered' means attempted delivery only. Also references ADR for logging behavior.

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?

Description is efficiently structured with purpose first, followed by operational details, warnings, return info, notes, and example. No filler; each sentence adds value.

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?

For a single-parameter testing tool with no output schema, the description covers all necessary aspects: purpose, mechanics, prerequisites, constraints, return format, side effects, and an example. No gaps.

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%, baseline 3. Description adds example usage and clarifies the parameter's role beyond the schema description. While not necessary, the example enhances understanding.

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?

The description clearly states the tool fires a synthetic event through a registered webhook to verify wiring. It distinguishes from sibling tools like webhook_register and webhook_list by focusing on testing. The verb 'fire' and resource 'webhook' are specific.

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?

Explicitly states when to use (verify webhook wiring) and when not to use (load testing). Mentions prerequisite environment variable. Does not require alternative tool mention as siblings are distinct.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/torsday/omnifocus-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server