Skip to main content
Glama
thenavidm
by thenavidm

Update newsletter list subscription

update_newsletter_list_subscription
Destructive

Update a newsletter list subscription's state, including unsubscribing a member. Requires confirmation and newsletter_lists:write for OAuth integrations.

Instructions

Update 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
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.
unsubscribeNoSet to true to unsubscribe the subscription from this newsletter list.
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
newsletter_list_idYesThe prefixed ID of the newsletter list object
newsletter_list_subscription_idYesThe prefixed ID of the newsletter list subscription 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

B3.4/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, so the safety profile is partly covered. The description adds meaningful context beyond that: it changes account state, requires an explicit confirm flag, and requires the newsletter_lists:write OAuth scope. This is solid added value for a mutation tool.

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 compact sentences, front-loaded with the action and its preconditions. The opening sentence duplicates the name/title, which is slightly wasteful, but overall there is little filler.

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 mutation tool with full schema coverage and complete annotations, the description supplies the missing pieces an agent needs: the state change, the confirm requirement, and the auth scope. It does not detail reversibility of the unsubscribe action, but with annotations and schema in place this is close to 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%, so the baseline is 3. The description reinforces the confirm flag's semantics ("for the user-requested action") but adds nothing about the unsubscribe flag, payload, or ID parameters beyond the schema.

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 states the verb and resource ("Update newsletter list subscription"), which matches the name and title almost verbatim. It does not specify what aspect of the subscription is actually changed (the schema reveals it is an unsubscribe flag), so the agent cannot distinguish the specific effect from the sibling create/get/delete subscription tools without opening the schema.

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?

"Requires confirm=true for the user-requested action" gives an actionable precondition for invoking the tool. However, there is no guidance on when to use this tool versus alternatives such as create_newsletter_list_subscription, newsletter_list_subscriptions_update_by_subscription_id, or get_newsletter_list_subscription.

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