Skip to main content
Glama

in_app_purchase_offer_codes_update_instance

Update an in-app purchase offer code by ID to modify its details or status through App Store Connect.

Instructions

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

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

D1.7/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. It says nothing about mutation semantics, required scopes/auth, whether changes are reversible, or side effects on related offer-code resources, leaving PATCH as the only implicit signal of a write.

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?

The description is short but wastes it on a verbatim duplicated endpoint: 'PATCH /v1/inAppPurchaseOfferCodes/{id} (PATCH /v1/inAppPurchaseOfferCodes/{id})'. The parenthetical repetition earns no place and crowds out any genuinely useful content.

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 nested body object, the description is inadequate: it defers entirely to an external OpenAPI schema reference and explains nothing about the update's scope or consequences.

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 merely points to components.schemas.InAppPurchaseOfferCodeUpdateRequest without adding field-level meaning beyond what the schema already declares.

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 restates the HTTP endpoint (PATCH /v1/inAppPurchaseOfferCodes/{id}) rather than describing the operation in domain terms. It conveys 'update an offer code' only implicitly via the path, and gives no differentiation from siblings like subscription_offer_codes_update_instance or in_app_purchase_offer_code_custom_codes_update_instance.

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 guidance on when to use this tool versus alternatives, no prerequisites, and no conditions for selecting it. The agent is left to infer everything from the endpoint path.

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