Skip to main content
Glama

win_back_offers_create_instance

Create a win-back offer in App Store Connect by submitting offer details through the API, so you can re-engage lapsed subscribers with a targeted promotion.

Instructions

POST /v1/winBackOffers (POST /v1/winBackOffers) Body shape: see OpenAPI components.schemas.WinBackOfferCreateRequest for the full JSON:API envelope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesJSON body. Shape: components.schemas.WinBackOfferCreateRequest.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

D1.8/5.0
Behavior1/5

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

No annotations are provided, so the description carries the full behavioral burden, and it discloses nothing: no required permissions, no side effects, no note that this is a mutation, and no indication of what a successful create returns. A single endpoint path is all that is offered.

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 parenthetical repeats the identical POST path verbatim, which is pure redundancy rather than concision. No sentence earns its place beyond naming the route.

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 a nested JSON:API envelope body, no annotations, and no output schema, the description is far too thin. It neither describes the envelope shape nor compensates for the missing behavioral and parameter context an agent needs to invoke it correctly.

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?

With one parameter at 100% schema description coverage, the baseline of 3 applies. The description points to components.schemas.WinBackOfferCreateRequest, but the schema's own body description already names that same schema, so no meaning is added.

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 is essentially a restatement of the name: 'POST /v1/winBackOffers' maps POST to create and winBackOffers to win_back_offers, which the name already conveys. It gives no explanation of what a win-back offer is or how creating one differs from the sibling update/delete/get win_back_offers tools.

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

Usage Guidelines1/5

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

There is no when-to-use guidance, no prerequisites, and no mention of alternatives. An agent is given no signal about when to create a win-back offer versus updating one or attaching offers via the subscription relationship tools.

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