Skip to main content
Glama

Register Webhook

register_webhook

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

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "webhookUrl": "<webhookUrl>",
      "name": "<name>",
      "eventTypes": "<eventTypes>"
    },
    "name": "register_webhook"
  }
}

Input 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

B3.2/5.0
Behavior3/5

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

Annotations already declare that this is a mutating, open-world, non-idempotent, non-destructive operation. The description adds useful context that delivery occurs via HTTP POST and that notifications are real-time, but it omits important behavioral details such as whether a signing secret is returned, whether duplicate URLs are allowed, and what happens to existing webhooks. With annotations covering the safety profile, this is an adequate but incomplete disclosure.

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?

The description is a single front-loaded sentence with zero filler, and the purpose is stated immediately. It is arguably too sparse for a three-parameter mutation tool, but every word earns its place.

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?

The schema fully covers the three required parameters and annotations cover the mutation safety profile. However, because there is no output schema, the description should ideally explain what registration returns, such as a webhook ID or secret, and it does not. It is minimally sufficient but leaves a gap for an agent that needs to know the result of a successful registration.

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%, so the schema fully documents name, eventTypes, and webhookUrl. The description adds no parameter-level meaning beyond what the schema already provides, which is acceptable at baseline 3 when the schema does the heavy lifting.

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?

The description states a specific verb and resource: 'Register a new webhook.' It also clarifies the outcome ('receive real-time document event notifications via HTTP POST'), which distinguishes it from read-only siblings like list_webhooks. However, it does not name or contrast with related mutating siblings such as delete_webhook or 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 Guidelines2/5

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

The description implies the tool is used when an agent wants real-time document event notifications, but it provides no explicit when-to-use guidance, no prerequisites, and no alternatives. It does not mention when to prefer list_webhooks, delete_webhook, or rotate_webhook_secret, nor does it warn about duplicate registrations.

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