Skip to main content
Glama

updatePassBySerial

Idempotent

Update a pass by serial number

Updates the dynamic data of an active pass looked up by serial number. Optionally sends a push notification to registered devices. At least one of data, expires_at, locations, relevant_date, or max_distance is required. When a serial has both Apple and Google passes, use ?wallet_type= to select which one (defaults to apple).

Scope: passes:manage

Maps to OpenAPI operationId updatePassBySerial — PATCH /manage-passes/serial/{serial_number}.

Same PassFast HTTP API, billing, and rate limits. Do not invent other paths.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoNew dynamic field values to merge into the pass.
x_app_idNoOverride X-App-Id for this call. Omit the connection header by default; set it only for multi-app orgs.
locationsNoGPS locations where the pass is relevant (overrides template defaults).
expires_atNoExpiration timestamp (set to null to remove expiration).
push_updateNoIf true, send a push notification to registered devices.
wallet_typeNoWallet type to look up when a serial number has both Apple and Google passes. Defaults to `apple` for backward compatibility. apple
max_distanceNoMaximum distance in meters from a location for lock screen relevance.
relevant_dateNoISO 8601 date when the pass is relevant (lock screen).
serial_numberYesPass serial number (unique within app + wallet type).
strip_image_idNoOverride the template's strip/hero image for this pass. The referenced image must belong to the same app and have purpose `strip` (or a `strip_*` variant). Applied to Apple `strip.png` and Google `heroImage` atomically (synced to the sibling pass for dual-wallet). Send `null` to clear the override and revert to the template's strip image. Omit the field to leave the current override unchanged.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / x_app_id / description
      Previous value: -"Override X-App-Id for this call. Defaults to the MCP connection header."New value: +"Override X-App-Id for this call. Omit the connection header by default; set it only for multi-app orgs."
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations, the description discloses the side effect of optionally sending push notifications, the active-pass prerequisite, the required scope (passes:manage), and the shared HTTP API/billing/rate-limit behavior, plus a directive not to invent other paths. This is substantial contextual information the structured annotations do not provide.

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 key summary sentence is front-loaded, followed by compact, high-value constraints, scope, and API mapping. Every sentence earns its place and no filler is present.

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 10-parameter mutation with nested objects and no output schema, the description covers preconditions, required-field constraints, auth scope, and API context. The main gap is that it does not describe the response/return value or error behavior for non-existent/inactive serials, which an agent would need when handling results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema already documents all 10 parameters, so the baseline is 3. The description adds real value by stating the cross-parameter 'at least one of...' requirement and clarifying how wallet_type resolves dual-wallet serials; it does not, however, compensate for details like strip_image_id's relationship to that requirement.

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?

First sentence uses a specific verb and resource: 'Update a pass by serial number', and adds the lookup key and active-pass constraint. This clearly distinguishes it from sibling updatePass and serial-based read/void tools without needing to open the schema.

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 gives concrete invocation conditions: only active passes, at least one of data/expires_at/locations/relevant_date/max_distance must be supplied, and wallet_type must be chosen when both Apple and Google passes share a serial. It does not explicitly name the alternative update tool (updatePass) or say when not to use it, so it falls 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.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.