Skip to main content
Glama
thenavidm
by thenavidm

List complimentary access

list_complimentary_access
Read-onlyIdempotent

Retrieve complimentary access records for a Beehiiv publication; supports pagination and optional tier/stats expansion. Requires complimentary_access:read for OAuth integrations.

Instructions

List complimentary access. Reads account data. OAuth integrations require complimentary_access:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoA limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
cursorNoUse this opaque cursor token to fetch the next page of results. Obtain the value from `next_cursor` in a previous response.
expandNoOptional list of expandable objects. `tier` - Returns the full tier object associated with this complimentary access. `stats` - Returns granted subscription counts.
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).
max_itemsNoMaximum records when all_pages=true. Returns continuation cursor and truncation.
publication_idYesThe prefixed ID of the publication object

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.1/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, so the safety profile is covered. The description adds a genuinely useful behavioral fact beyond the structured data: the required OAuth scope 'complimentary_access:read', which tells the agent a call can fail on permissions. It stops short of richer context (pagination cost of all_pages, truncation behavior), but the auth requirement is real added value.

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 short, front-loaded sentences with zero padding; the purpose leads and the auth constraint trails. The first sentence is near-redundant with the title, which is the only waste.

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 read-only list tool with 100% schema coverage and full annotations, the description covers the essentials. However, with no output schema it gives no hint of what is returned, and it omits pagination guidance and any differentiation from get_complimentary_access, leaving clear gaps.

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 all seven parameters (limit, cursor, expand, account, all_pages, max_items, publication_id) are already documented in the schema. The description adds no parameter-level meaning, so the baseline 3 applies.

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

Purpose3/5

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

The description gives a verb+resource ('List complimentary access'), but it is essentially a restatement of the tool title with no scope qualifiers. It never distinguishes itself from the sibling get_complimentary_access, leaving the agent to infer the list-vs-single distinction 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?

There is no when-to-use guidance, no condition that selects this tool over get_complimentary_access, and no exclusions. 'Reads account data' describes behavior, not usage context, so the agent gets no routing help.

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