Skip to main content
Glama
erayendes

Heimdall App Store Connect MCP

by erayendes
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript

apps__background_assets__list

Read-onlyIdempotent

Retrieve background assets for a specific app using its ID, with filtering, sorting, and pagination to manage asset data efficiently.

Instructions

List the background assets belonging to an app. [GET /v1/apps/{id}/backgroundAssets]

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_archivedNofilter by attribute 'archived'
filter_versions.localeNofilter by attribute 'versions.locale'
fields_backgroundAssetsNothe fields to include for returned resources of type backgroundAssets Return only these attributes. A full row set can exceed 200 KB.
filter_versions.platformsNofilter by attribute 'versions.platforms'
filter_assetPackIdentifierNofilter by attribute 'assetPackIdentifier'

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_backgroundAssets
      Added value: +{
+  "description": "the fields to include for returned resources of type backgroundAssets Return only these attributes. A full row set can exceed 200 KB.",
+  "items": {
+    "enum": [
+      "archived",
+      "assetPackIdentifier",
+      "createdDate",
+      "usedBytes",
+      "app",
+      "versions",
+      "appStoreVersion",
+      "internalBetaVersion",
+      "externalBetaVersion"
+    ],
+    "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.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, covering the safety profile. The description adds the GET endpoint, reinforcing read-only behavior, but does not disclose pagination, response shape, or auth context.

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?

One tight sentence plus the endpoint path, with no filler or redundant restatement of the tool name.

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 read-only list endpoint, the schema fully documents the 10 parameters and the description gives the resource and scope. The absence of an output schema is manageable for a standard list call, though a note on the return shape or pagination would make it fully complete.

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?

All 10 parameters have schema descriptions, so the description does not need to repeat them. It adds no extra semantics about id, sort, filters, include, or pagination beyond what the schema already provides.

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

Purpose4/5

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

Description names a specific action ('List'), a concrete resource ('background assets'), and a clear scope ('belonging to an app'), so an agent can tell what the endpoint returns. It does not explicitly differentiate from siblings, but the resource is distinct from the many other apps__* list tools.

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 guidance is implied by the verb and resource: use it when background assets for an app are needed. It provides no explicit when-not-to-use guidance or alternative endpoints, though there is no obvious same-resource sibling.

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