Skip to main content
Glama

webhooks_update_instance

Update an existing App Store Connect webhook by ID to modify its URL, events, or status. Use it to adjust webhook configurations without creating a new one.

Instructions

PATCH /v1/webhooks/{id} (PATCH /v1/webhooks/{id}) Body shape: see OpenAPI components.schemas.WebhookUpdateRequest for the full JSON:API envelope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesthe id of the requested resource
bodyYesJSON body. Shape: components.schemas.WebhookUpdateRequest.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

C2.2/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full disclosure burden and largely drops it. The PATCH verb implies mutation of an existing resource, but there is no mention of required permissions, which fields are mutable, whether the update is a merge or replace, or any side effects (e.g., re-triggering webhook delivery).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is short, but the path is duplicated verbatim in parentheses ("(PATCH /v1/webhooks/{id})"), which is pure noise. The content is a pointer to an external schema rather than a front-loaded statement of purpose.

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

Completeness2/5

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

For a mutation tool with no annotations, no output schema, and a nested-object body, the description is far too thin. It omits what fields are updatable, permission requirements, and error behavior, leaving the agent dependent on an external OpenAPI document it may not have.

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% — both `id` and `body` are documented in the schema, so the baseline is 3. The description's pointer to components.schemas.WebhookUpdateRequest merely duplicates what the schema already says, adding no new syntax or format detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

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

The description only restates the tool's identity as a raw HTTP route ("PATCH /v1/webhooks/{id}"), echoing the name rather than stating in plain terms that it updates an existing webhook's configuration. It does not distinguish this from sibling tools like webhooks_get_instance, webhooks_delete_instance, or webhooks_create_instance.

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 guidance on when to use this tool versus the other webhook tools, nor any prerequisites. The PATCH verb weakly implies a partial-update intent, but nothing states what can be changed or under what conditions.

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

Deploy Server

Other Tools