Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Update Webhook

update_webhook
Idempotent

Modify a webhook endpoint's URL, subscribed event types, or enabled flag; re-enable a disabled endpoint to reset its failure count after 20 consecutive failures.

Instructions

Update a webhook endpoint's URL, event types and/or enabled flag (PATCH). Re-enabling (enabled=true) after an automatic disable (20 consecutive failures) resets its failure count. Give at least one field.

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": {
      "webhook_id": "<webhook_id>"
    },
    "name": "update_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNo
enabledNo
webhook_idYes
event_typesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare non-read-only, idempotent, non-destructive, open-world behavior, so the description only needs to add side-effect context — and it does: PATCH/partial-update semantics and the non-obvious fact that re-enabling after the 20-consecutive-failure auto-disable resets the failure counter. It does not mention auth/permission requirements or validation behavior for an invalid URL.

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?

Two short sentences that are front-loaded with the core action and mutable fields, then the conditional side effect, then the minimum-input rule. No filler or redundant restatement of the schema.

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?

An output schema exists so return values need no explanation, and annotations cover the safety profile; the description fills in partial-update semantics and the failure-count reset. Gaps are minor: no mention of the required webhook_id as the targeting parameter and no auth prerequisites.

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?

With 0% schema description coverage, the description must compensate, and it names three of the four parameters with meaningful semantics (

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?

Specific verb+resource ("Update a webhook endpoint") with the exact mutable fields enumerated (URL, event types, enabled flag) and HTTP verb (PATCH) stated. It does not explicitly distinguish itself from siblings like rotate_webhook_secret or delete_webhook, but the operation is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

"Give at least one field" is a real usage constraint that matters because every field defaults to null, and the re-enable note tells the agent when toggling enabled=true has a side effect. However, there is no routing guidance to alternatives (e.g., that secrets are changed via rotate_webhook_secret, or that new endpoints require create_webhook) and no when-not-to-use condition.

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