Skip to main content
Glama

Register Webhook

register_webhook

Register a new webhook to receive real-time document event notifications via HTTP POST.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesFriendly name to identify this webhook
eventTypesYesEvent types to subscribe to
webhookUrlYesPublic HTTPS URL that will receive webhook POST requests

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations mark this as a safe, non-destructive operation (readOnlyHint=false, destructiveHint=false). The description adds that registration creates a webhook that receives document event notifications via HTTP POST, which is useful context. It does not disclose delivery guarantees, verification handshakes, or what the response contains, but the annotations lower the burden.

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?

A single, well-structured sentence states the action, object, purpose, and delivery mechanism without wasted words.

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?

For a simple create operation, the description plus schema and annotations cover the essentials. However, there is no output schema and the description omits practical invocation details such as URL validation expectations, auth implications, or what is returned after registration. This is adequate but not rich.

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 each parameter already has a clear description. The tool description does not add meaning beyond the schema, so the baseline of 3 applies.

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 names a specific verb ('Register'), a resource ('new webhook'), and the exact purpose ('receive real-time document event notifications via HTTP POST'). It is clearly distinct from lifecycle siblings like delete_webhook, list_webhooks, and rotate_webhook_secret.

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?

The description gives a clear context for when to use the tool: creating a webhook to receive real-time event notifications over HTTP POST. It does not explicitly name alternatives such as listing or rotating existing webhooks, but the intended use case is reasonably clear and no exclusion criteria are needed for a creation endpoint.

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