Skip to main content
Glama

in_app_purchase_offer_codes_create_instance

Create an in-app purchase offer code in App Store Connect to generate redeemable codes for promotions, access, or customer offers via Apple's API.

Instructions

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

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

C2.1/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 states nothing about required permissions, whether the created offer code starts active or in draft, idempotency, side effects, or error behavior — only the HTTP verb and path.

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

Conciseness3/5

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

It is short, but the path is duplicated in parentheses and the schema reference repeats what the input schema already states, so the few words present are partly redundant rather than front-loaded value.

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 mutating create tool with no annotations and no output schema, the description should explain the resource and the request envelope. Instead it defers the entire body shape to an external OpenAPI component reference, leaving an agent unable to construct a valid request from this definition alone.

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% (the single body parameter already points to components.schemas.InAppPurchaseOfferCodeCreateRequest), so the baseline is 3. The description merely repeats the same schema pointer verbatim and adds no syntax, required-field, or envelope detail beyond the schema.

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 tautology: 'POST /v1/inAppPurchaseOfferCodes' restates the tool name (create_instance for in_app_purchase_offer_codes) without saying what an offer code is or what creating one accomplishes. It gives no distinction from siblings like subscription_offer_codes_create_instance or in_app_purchase_offer_code_custom_codes_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 when-to-use guidance, no prerequisites, and no mention of alternatives, despite a large family of sibling create_instance tools for offer codes. The agent must infer everything from the name alone.

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