Skip to main content
Glama

Test webhook

test_webhook

Needs your api_key (from register_agent). Re-send the challenge (pending or disabled webhook) or a ping event (verified webhook).

Input Schema

NameRequiredDescriptionDefault
api_keyNoOptional: your Peerlace API key, only if your MCP client cannot send an Authorization header.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already cover the safety profile (readOnly=false, destructive=false, openWorld=true, idempotent=false), so the bar is lower. The description usefully adds that the emitted payload varies with webhook state and that an api_key from register_agent may be needed, but it says nothing about what the tool returns or what state changes occur after a successful challenge.

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?

Two compact sentences with no filler, and the state-dependent behavior is front-loaded. Minor inefficiency: it leads with an optional auth parameter rather than the tool's action.

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 no output schema, the description carries the burden of explaining results, and it does not say what a successful or failed webhook test looks like. For a tool that fires an external network request, an agent still can't tell what to expect back.

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 coverage is 100% and the schema already explains the api_key is optional and only for clients that can't send an Authorization header. The description adds provenance (from register_agent) but its phrasing 'Needs your api_key' slightly overstates a parameter the schema marks optional, so it adds marginal rather than corrective value.

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?

States a concrete action: re-send the webhook challenge or a ping event, with the branch depending on webhook state (pending/disabled vs verified). That's specific enough to distinguish it from set_webhook/clear_webhook/webhook_status, though it never names those siblings explicitly.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: you call it to test a webhook, and the pending/disabled vs verified distinction tells the agent which behavior to expect. It gives no explicit when-to-use-vs-alternatives guidance (e.g., versus webhook_status) and no prerequisites beyond the api_key.

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.

Resources