Skip to main content
Glama
thenavidm
by thenavidm

Get newsletter list

get_newsletter_list
Read-onlyIdempotent

Retrieve a Beehiiv newsletter list by publication ID and newsletter list ID to read account data; requires newsletter_lists:read for OAuth integrations.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
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

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 safety is covered. The description adds genuinely new operational context: it reads account data (tying to the account parameter) and requires the newsletter_lists:read OAuth scope, which an agent cannot learn from the structured fields.

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 sentences, front-loaded with the action, with no filler. The only waste is the opening sentence, which simply echoes the tool title rather than carrying new 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 simple read-only getter with full schema coverage and no output schema, the definition is adequate but not complete: it never disambiguates from list_newsletter_lists, and gives no hint about what a newsletter list contains or whether the list ID must belong to the given publication.

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% across all three parameters, so the schema already documents account, publication_id and newsletter_list_id with patterns. The description only obliquely references "account data" and adds no format or constraint detail beyond the schema, so 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?

"Get newsletter list" states a verb and resource, but it is essentially a restatement of the tool name/title and adds no scope detail. The sibling list_newsletter_lists is dangerously similar, and nothing here clarifies that this fetches one list by ID rather than listing all lists.

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?

"Reads account data" and the OAuth scope note are prerequisites, not usage guidance. There is no statement of when to use this versus list_newsletter_lists or the other get_* newsletter-list siblings, leaving selection to inference from the name alone.

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