Skip to main content
Glama

Update webhook

update_webhook
DestructiveIdempotent

Updates a webhook's URL, subscribed events, or active state. Every field besides id is optional.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe webhook endpoint id, as returned by list_webhooks or create_webhook.
urlNoNew https:// delivery URL (plain http:// only for localhost; internal addresses are rejected). Omit to leave it unchanged.
nameNoNew label; null clears it. Omit to leave it unchanged.
isActiveNofalse pauses deliveries to this endpoint without deleting it; true resumes them. Omit to leave it unchanged.
eventTypesNoReplaces the subscribed events; at least one. Omit to leave them unchanged.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
urlYes
nameYes
isActiveYes
createdAtYes
eventTypesYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and idempotentHint=true. The description adds the useful detail that fields are optional and thus the update is partial, which is not in the annotations. It does not disclose that eventTypes are replaced (though the schema covers that) or explain what destructiveHint implies (e.g., pausing deliveries). Overall, it adds some context but relies on schema and annotations for the rest.

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?

One sentence, front-loaded with the verb and resource, and the optionality note is the only extra detail. Zero wasted words; every element earns its place.

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?

With an output schema present and full parameter coverage in the schema, the description adequately covers the tool's purpose and partial-update semantics. It does not mention error cases or prerequisites like 'id must reference an existing webhook', but the schema's required field and the id description ('as returned by list_webhooks') cover that. For a typical update operation, this is complete enough.

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 100%, so every parameter already has a thorough description in the schema. The description mentions 'URL, subscribed events, or active state' but adds no syntax, format, or constraint details beyond what the schema provides. This meets the baseline for high schema coverage.

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 clear verb-resource pair ('Updates a webhook') and specifies the exact fields modified (URL, subscribed events, active state). This distinguishes it from siblings like create_webhook, delete_webhook, get_webhook, and list_webhooks without needing to inspect schemas.

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 clearly implies when to use this tool (for modifying an existing webhook) and signals the partial-update pattern ('Every field besides id is optional'), which guides usage. However, it does not explicitly name alternatives like create_webhook or state when not to use it, so it stops short of full explicit routing.

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