Skip to main content
Glama

create_webhook

Create a webhook endpoint that receives job events such as job.completed and job.failed at an HTTPS URL. Use it to be notified instead of polling get_verification or get_batch. Returns the signing secret once (field secret); store it, it is never shown again. The number of active endpoints is capped by the plan. Use update_webhook to change an endpoint and list_webhooks to see them. Requires the webhooks:create scope.

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": {
      "url": "<url>",
      "events": "<events>"
    },
    "name": "create_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesTarget URL that receives event notifications.
eventsYesEvent type strings to subscribe to (e.g. job.completed, job.failed).
descriptionNoOptional human-readable description of the endpoint.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the one-time signing secret (never shown again), the plan-based cap on active endpoints, the HTTPS requirement, and the required webhooks:create scope. It does not cover failure behavior, idempotency, or delivery retry semantics, so it falls short of fully transparent.

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?

Front-loads the core action in the first sentence, then usage, then the irreversible-secret warning, then routing, then auth. Five sentences with no filler, each carrying distinct operational information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 3-parameter create tool with no output schema, the description covers purpose, the returned secret field, plan limits, and required scope. Error responses and what the endpoint record looks like beyond the secret are unstated, a minor gap.

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 the baseline is 3, but the description adds genuine meaning beyond the schema: the target URL must be HTTPS, and events correspond to the same job.* types used elsewhere. The optional description field is not elaborated, which keeps it from a 5.

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?

States a specific verb and resource plus the mechanism: 'Create a webhook endpoint that receives job events such as job.completed and job.failed at an HTTPS URL'. It also distinguishes itself from nearby siblings by naming update_webhook, list_webhooks, and the polling alternatives get_verification/get_batch.

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 frames the use case as an alternative to polling ('Use it to be notified instead of polling get_verification or get_batch') and routes related operations to update_webhook and list_webhooks. The agent knows both when to pick this tool and where to go for adjacent tasks.

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