Skip to main content
Glama
thenavidm
by thenavidm

Create newsletter list subscription

create_newsletter_list_subscription
Destructive

Subscribe an email address or existing subscription to a Beehiiv newsletter list. Requires confirm=true for the action and newsletter_lists:write for OAuth.

Instructions

Create newsletter list subscription. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require newsletter_lists:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoThe email address of the subscription to subscribe. Either subscription_id or email must be provided.
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
publication_idYesThe prefixed ID of the publication object
subscription_idNoThe prefixed ID of the subscription to subscribe. Either subscription_id or email must be provided.
newsletter_list_idYesThe prefixed ID of the newsletter list object

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.0.1
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for every account mutation. Confirms only the user-requested action."New value: +"Set true only when the user asked for exactly this action."
  2. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, but the description adds context the annotations do not: it mutates account state, requires an explicit confirm=true gate, and demands the newsletter_lists:write OAuth scope. That is real added value. It stops short of describing reversibility or error behavior.

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 and then the two constraints (confirm gate, OAuth scope). No filler. "Changes account state" is slightly vague but the sentence still earns its place as a mutation warning.

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 destructive 8-parameter tool with a nested payload object and no output schema, the description covers the essentials an agent needs before invoking: state mutation, the confirm gate, and the required OAuth scope. It omits interaction rules between payload/payload_file/body flags and any return information, but those gaps are largely handled by the schema.

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 8 parameters, including the nested payload/payload_file alternates and the subscription_id-or-email rule, are already documented in the schema. The description only echoes the confirm parameter, adding no syntax or format meaning beyond the structured data, so the baseline 3 applies.

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?

States a specific verb and resource ("Create newsletter list subscription"), which is clear enough to distinguish it from list/get/update newsletter-list-subscription siblings. It does not, however, contrast itself with the closely related create_subscription or create_bulk_subscription tools, so an agent must infer the boundary.

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?

The line "requires confirm=true for the user-requested action" gives a concrete usage rule for the confirm flag, which is genuinely useful. But there is no guidance on when to choose this tool over create_subscription, update_newsletter_list_subscription, or the bulk variants, and no explicit exclusions.

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