Skip to main content
Glama
thenavidm
by thenavidm

Update subscriptions' status

bulk_subscription_updates_patch_status
Destructive

Bulk update subscription statuses in Beehiiv. Set confirm=true only after the user explicitly requests the status change.

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

A3.7/5.0
Behavior4/5

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

Goes beyond the annotations (destructiveHint=true, idempotentHint=false) by disclosing that the operation changes account state, that a confirm flag gates it, and that a specific OAuth scope is required. It does not explain reversibility or the effect of the bulk update on existing subscriptions, but the added auth/confirmation context is meaningful.

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 tight sentences with the core action front-loaded and no redundancy. It could be slightly richer given the tool's complexity, but every sentence carries weight.

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 7-parameter, nested-object mutation with no output schema, the description covers the risk-critical aspects (confirmation gate, auth scope, state change) and the full schema fills in the parameter details. The main gap is disambiguation from the closely named PATCH/PUT siblings, which an agent must still resolve on its own.

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 schema already documents all seven parameters including the mutually exclusive payload/payload_file/body-flags relationship. The description echoes the confirm parameter's meaning but adds no format or constraint detail beyond the schema, matching the baseline of 3.

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 ('Update subscriptions' status') and the scope is bulk, so an agent can identify the operation. However, it does not distinguish itself from the very similar sibling `bulk_subscription_updates_put_status` or `replace_bulk_subscription_update`, leaving the PATCH-vs-PUT choice to inference.

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?

Adds two useful invocation conditions: confirm=true is required for user-requested actions, and OAuth integrations need the subscriptions:write scope. It gives no guidance on when to choose this PATCH path over the PUT/replace siblings that target the same resource.

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