Skip to main content
Glama
erayendes

Heimdall App Store Connect MCP

by erayendes
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript

apps__promoted_purchases__list

Read-onlyIdempotent

List promoted purchases for a given App Store app, optionally including in-app purchases or subscriptions. Retrieve paginated results and select specific fields to manage app promotion visibility.

Instructions

List the promoted purchases belonging to an app. [GET /v1/apps/{id}/promotedPurchases]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesApp name, bundle ID (com.example.app) or numeric Apple ID.
limitNomaximum resources per page
includeNocomma-separated list of relationships to include Pull related records in the same call. Without it, checking a relationship costs one extra call per row returned.
next_urlNoAbsolute links.next URL from a previous response.
fields_promotedPurchasesNothe fields to include for returned resources of type promotedPurchases Return only these attributes. A full row set can exceed 200 KB.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.3.0
    • changedInput schema / properties / id / description
      Previous value: -"ID from the matching list call."New value: +"App name, bundle ID (com.example.app) or numeric Apple ID."
  2. Changed1 schema field changedv2.0.1
    • addedInput schema / properties / id / description
      Added value: +"ID from the matching list call."
  3. Changed4 schema fields changedv2.0.0
    • addedInput schema / properties / fields_promotedPurchases
      Added value: +{
+  "description": "the fields to include for returned resources of type promotedPurchases Return only these attributes. A full row set can exceed 200 KB.",
+  "items": {
+    "enum": [
+      "visibleForAllUsers",
+      "enabled",
+      "state",
+      "inAppPurchaseV2",
+      "subscription"
+    ],
+    "type": "string"
+  },
+  "type": "array"
+}
    • removedInput schema / properties / id / description
      Removed value: -"Resource identifier."
    • changedInput schema / properties / include / description
      Previous value: -"comma-separated list of relationships to include"New value: +"comma-separated list of relationships to include Pull related records in the same call. Without it, checking a relationship costs one extra call per row returned."
    • changedInput schema / properties / next_url / description
      Previous value: -"Absolute `links.next` URL from a previous response, to fetch the next page. When set, all other parameters are ignored."New value: +"Absolute links.next URL from a previous response."
  4. First observedv1.3.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds only the app-scoping constraint and the GET method, but does not reveal behavioral details such as pagination cost, relationship-fetching implications, or response shape beyond what the schema and annotations already imply.

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

Conciseness5/5

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

The description is a single, front-loaded sentence that directly states the action, resource, scope, and endpoint. There is no filler, repetition, or unnecessary context.

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

Completeness4/5

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

For a simple, read-only list operation with full parameter documentation and safety annotations, the description is mostly sufficient. It clearly identifies the scope and operation; the main gap is that there is no output schema and the description does not describe the return shape, though that is partially inferable from the list semantics and the field-selection parameter.

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%, and the schema itself documents all five parameters with meaningful detail, including pagination, relationships, and field selection. The tool description adds no parameter-level meaning of its own, so the baseline of 3 applies.

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

Purpose5/5

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

The description uses a specific verb ('List') plus a precise resource ('promoted purchases') and an app-scoping qualifier ('belonging to an app'). It also includes the exact GET endpoint, making the operation unambiguous and distinguishing it from the sibling mutation tool apps__promoted_purchases__replace.

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

Usage Guidelines3/5

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

Usage context is implied by the verb 'List' and the endpoint pattern, but the description gives no explicit guidance about when to choose this tool over alternatives, such as when a caller needs to modify promoted purchases rather than read them. There is no 'use this when...' or exclusionary note.

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