Skip to main content
Glama
thenavidm
by thenavidm

Update subscriptions' status

bulk_subscription_updates_put_status
Destructive

Change subscription statuses in bulk for a Beehiiv publication. Provide subscription IDs and the new status; confirm=true is required to execute.

Instructions

Update subscriptions' status. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require subscriptions: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.
new_statusNoThe new status to set for the subscriptions
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_idsNoAn array of subscription IDs to be updated

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 and non-idempotent behavior, so the safety profile is covered. The description adds genuinely useful context beyond that: it discloses that account state changes, that confirm=true is mandatory, and that OAuth integrations need the subscriptions:write scope. This is meaningful extra disclosure over 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 and followed by the safety and auth notes. Every sentence carries information and there is no padding, though it is too terse to fully exploit the space.

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 destructive bulk-update tool with 7 parameters, a nested payload object, and no output schema, the description covers purpose, confirmation, and auth but omits bulk semantics, the publication_id requirement, and the mutually exclusive payload/payload_file/body-flag input modes. It is 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%, so every parameter is already documented in the schema, setting the baseline at 3. The description only echoes the confirm requirement and adds no format or relational detail (e.g. how payload, payload_file, and body flags interact), so it does not add value beyond the schema.

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?

The description states a specific verb and resource ('Update subscriptions' status'), which is clear enough on its own. However, it does not differentiate this bulk operation from the many similar siblings such as bulk_subscription_updates_patch_status, update_bulk_subscription_update, or replace_bulk_subscription_update, so an agent cannot tell them apart from the text 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?

The only usage-relevant statement is that confirm=true is required for the user-requested action, which is a precondition rather than when-to-use guidance. There is no indication of when to choose this PUT-status variant over the PATCH or update siblings, so alternative selection is left entirely to inference from tool names.

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