Skip to main content
Glama

Update webhook

update_webhook
Destructive

Modify an existing Bannerbear webhook by UID to change its endpoint URL, event triggers, status, or resource type; confirmation is required before changes apply.

Instructions

PATCH /v5/webhooks/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidYes
accountNoExact private workspace profile label; no fallback to another profile key.
confirmNoMust be true for this exact requested render, upload, edit, install or delete.
payloadNoComplete current native JSON body. Use payload or payload_file exclusively.
payload_fileNoRegular non-symlink local JSON file, at most 1 MiB.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.1/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuinely non-redundant operational context: mandatory confirmation before provider execution, a single-submission rule (no retry), and that provider scopes, locks, and credits apply. It still omits what specifically is destroyed or changed, keeping it short of a 5.

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 definition is short and front-loads the endpoint, with no wasted clauses at the sentence level. However, 'Current Bannerbear V5 operation' is generic filler that does not add actionable information. Overall compact and readable.

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 destructive, non-idempotent mutation with no output schema and a nested payload object, the description covers the confirmation/one-shot constraint but says nothing about what a successful update returns or what happens on failure. Combined with annotations and 80% schema coverage it is minimally adequate, not complete.

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 description coverage is 80%, so the schema already documents uid, account, confirm, payload, payload_file, and the nested enum fields. The description adds nothing about parameters and does not explain exclusivity or the effect of the nested payload fields beyond what the schema states. Baseline 3 applies 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.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description conveys the operation only through the raw REST path 'PATCH /v5/webhooks/{uid}', which does imply updating a webhook but never states in prose what it changes (url, event, status, resource). It does not differentiate itself from siblings such as create_webhook, delete_webhook, or get_webhook beyond the HTTP verb. Purpose is inferable but not articulated.

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?

There is no when-to-use guidance and no mention of alternatives or preconditions relative to the sibling webhook tools. The 'Mandatory confirmation before provider execution; one submission only' line is an execution constraint rather than a selection guide. An agent gets no help deciding between this and other webhook operations.

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