Skip to main content
Glama

win_back_offers_update_instance

Update an existing win-back offer in App Store Connect by submitting a JSON:API PATCH request with the offer ID and changed fields.

Instructions

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

Input Schema

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

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, yet it says nothing about permissions, whether PATCH is a merge or replace, what happens to fields not included, or impact on live subscribers. The duplicated path gives no behavioral context beyond 'this is a PATCH'.

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 wasteful: the endpoint is printed twice verbatim in parentheses, and the second half is a pointer to an external document rather than content. No front-loaded statement of what the tool does.

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

Completeness1/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 body defined only by an out-of-band schema reference, the description supplies none of the information an agent needs to invoke it safely or correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Top-level schema coverage is 100%, but the only parameter of consequence, 'body', is an untyped object with additionalProperties: {} whose real shape lives in an external OpenAPI component. The description merely redirects to that reference without describing any field, so it adds nothing usable and leaves the nested payload opaque to the caller.

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 path segment 'winBackOffers' plus the PATCH verb identify the resource and operation well enough that an agent can distinguish this from win_back_offers_create_instance, get_instance and delete_instance. However, the description never states in plain language that it modifies an existing win-back offer, and the parenthetical merely repeats the same endpoint string instead of clarifying intent.

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 versus the create/delete siblings, nor prerequisites such as owning the offer or the subscription it belongs to. Only the implicit HTTP-verb semantics of PATCH hint at partial modification.

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