Skip to main content
Glama
erayendes

Heimdall App Store Connect MCP

apps__subscription_groups__list

Read-onlyIdempotent

List subscription groups for a specific app using its name, bundle ID, or Apple ID. Filter, sort, and include related subscriptions and localizations to manage App Store Connect offerings.

Instructions

List the subscription groups belonging to an app. [GET /v1/apps/{id}/subscriptionGroups]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesApp name, bundle ID (com.example.app) or numeric Apple ID.
sortNocomma-separated list of sort expressions; resources will be sorted as specified
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.
filter_referenceNameNofilter by attribute 'referenceName'
fields_subscriptionGroupsNothe fields to include for returned resources of type subscriptionGroups Return only these attributes. A full row set can exceed 200 KB.
filter_subscriptions.stateNofilter by attribute 'subscriptions.state'

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_subscriptionGroups
      Added value: +{
      +  "description": "the fields to include for returned resources of type subscriptionGroups Return only these attributes. A full row set can exceed 200 KB.",
      +  "items": {
      +    "enum": [
      +      "referenceName",
      +      "subscriptions",
      +      "subscriptionGroupLocalizations",
      +      "versions"
      +    ],
      +    "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

A4.1/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 agent knows this is a safe read operation. The description reinforces this with a GET endpoint but adds no further behavioral detail such as pagination or relationship inclusion behavior, which are covered in the schema.

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 two short sentences, with the core purpose front-loaded and the endpoint annotation as supplementary context. No extraneous content.

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

Completeness5/5

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

Given that all 8 parameters are documented in the schema and annotations cover the safety profile, the description is sufficient for an agent to call this simple list operation correctly. No output schema exists, so return-value details are not required.

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 coverage is 100% and all parameters, including id, sort, limit, include, and filters, are described in the input schema. The description does not add parameter-specific meaning beyond the schema, so baseline 3 is appropriate.

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 states a specific verb ('List') and resource ('subscription groups belonging to an app'), distinguishing it from sibling list tools like apps__builds__list or apps__list. The scope is precise and the resource is unambiguous.

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

Usage Guidelines4/5

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

The description provides clear context: this tool is for retrieving subscription groups tied to a specific app, identified by the required 'id' parameter. However, it does not explicitly name alternatives or state when not to use it, so it stops short of a 5.

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