Skip to main content
Glama

Postscript List Subscribers

postscript_list_subscribers
Read-onlyIdempotent

List SMS subscribers for a Postscript (Shopify) shop. Supports filtering by email, phone number, Shopify customer ID, and created/updated timestamps, plus sorting. Page-based pagination: returns { page_info: { page, total_pages }, subscribers: [...] }; pass page to walk results.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "page": 1,
      "sort": "created_at__desc",
      "_apiKey": "your-postscript-api-key"
    },
    "name": "postscript_list_subscribers"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo1-indexed page number (default 1). Walk until page === page_info.total_pages.
sortNoSort spec like "created_at__desc" or "updated_at__asc".
_apiKeyYesPostscript Private API token (Bearer). From Settings -> API.
email__eqNoExact email match.
created_at__gteNoISO timestamp; subscribers created on/after this time.
created_at__lteNoISO timestamp; subscribers created on/before this time.
email__containsNoSubstring email match.
updated_at__gteNoISO timestamp; subscribers updated on/after this time.
phone_number__eqNoExact phone match (E.164, e.g. +15551234567).
phone_number__containsNoSubstring phone match.
shopify_customer_id__eqNoExact Shopify customer ID match.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / _apiKey / description
      Previous value: -"Postscript Private API token (Bearer). From Settings → API."New value: +"Postscript Private API token (Bearer). From Settings -> API."
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "_apiKey": "your-postscript-api-key",
      +    "page": 1,
      +    "sort": "created_at__desc"
      +  },
      +  {
      +    "_apiKey": "your-postscript-api-key",
      +    "created_at__gte": "2024-01-01T00:00:00Z",
      +    "phone_number__eq": "+15551234567"
      +  }
      +]
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so safety is covered. The description adds real value beyond them by disclosing the exact response envelope ({ page_info: { page, total_pages }, subscribers: [...] }) and the loop-termination rule, which the agent cannot infer from annotations.

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

Conciseness4/5

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

Three sentences, front-loaded with purpose, then capabilities, then pagination contract — no filler. The filter enumeration partially restates schema fields, which is the only slight redundancy.

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?

For an 11-parameter read-only listing tool with no output schema, the description covers purpose, filter surface, sort, and the return shape plus pagination walk. Combined with 100% schema coverage and annotations carrying the safety profile, an agent has everything needed to call it correctly.

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%, so every one of the 11 parameters is already documented with format details like ISO timestamps and E.164 phone numbers. The description only summarizes the filter categories ('email, phone number, Shopify customer ID, and created/updated timestamps, plus sorting') without adding syntax or defaults beyond the schema, matching the baseline for a fully documented schema.

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?

The first sentence gives a specific verb and resource: 'List SMS subscribers for a Postscript (Shopify) shop.' That clearly separates it from a single-record fetch, though it never names the sibling get tool (postscript_get_subscriber) as the alternative for one-off lookups, so differentiation is inferred rather than stated.

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 is implied through the filter list and the explicit instruction to 'pass page to walk results', which tells the agent how to paginate. However, there is no guidance on when to prefer this over postscript_get_subscriber or list_subscriptions, and no exclusions or prerequisites are stated.

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.