Skip to main content
Glama
thenavidm
by thenavidm

List newsletter list subscriptions

list_newsletter_list_subscriptions
Read-onlyIdempotent

Retrieve subscriptions for a specific Beehiiv newsletter list using publication and list IDs. Supports pagination and reading all pages for subscriber data.

Instructions

List newsletter list subscriptions. Reads account data. OAuth integrations require newsletter_lists:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo**Offset-based pagination (deprecated)**: Page number for offset-based pagination. Please migrate to cursor-based pagination using the `cursor` parameter. If not specified, results 1-10 from page 1 will be returned.
limitNoA limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
cursorNo**Cursor-based pagination (recommended)**: Use this opaque cursor token to fetch the next page of results. When provided, pagination will use cursor-based method which is more efficient and consistent than offset-based pagination.
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
all_pagesNoRead successive cursor pages, bounded by max_items (default 1000).
directionNoThe direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending, sorts from largest to smallest.asc
max_itemsNoMaximum records when all_pages=true. Returns continuation cursor and truncation.
publication_idYesThe prefixed ID of the publication object
newsletter_list_idYesThe prefixed ID of the newsletter list object

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, but the description adds a genuinely useful layer beyond them: 'Reads account data' and the required OAuth scope newsletter_lists:read. Those are auth/context disclosures the annotations cannot express, though nothing is said about pagination behavior or result size.

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?

Three short sentences with zero filler; the action, the data reading, and the auth requirement are front-loaded in that order. Nothing could be removed without losing information.

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

Completeness3/5

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

For a paginated list tool with no output schema, the description says nothing about what a subscription record contains or how pagination/continuation cursors behave, though the schema covers the pagination mechanics. The auth and account-reading notes make it minimally adequate rather than 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?

Schema description coverage is 100%, including detailed guidance on cursor vs deprecated offset pagination, limit bounds, and all_pages/max_items. The description adds no parameter-level meaning, so the baseline 3 is appropriate.

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?

Names a specific verb+resource (list newsletter list subscriptions) that is clearly narrower than the sibling list_subscriptions and distinct from get_newsletter_list_subscription. It does not explicitly contrast itself with those siblings, so an agent must infer the difference from the name alone.

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

Usage Guidelines2/5

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

No when-to-use guidance, no exclusions, and no alternatives named. The auth note ('OAuth integrations require newsletter_lists:read') is a prerequisite, not a routing rule, so the agent gets no help choosing between this and list_subscriptions or the single-subscription getter.

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