Skip to main content
Glama
thenavidm
by thenavidm

Get subscription update

get_bulk_subscription_update
Read-onlyIdempotent

Fetches a publication's bulk subscription update by ID so you can inspect status, results, and applied changes.

Instructions

Get subscription update. Reads account data. OAuth integrations require subscriptions: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
bulk_subscription_update_idYesThe ID of the Subscription Update object

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds one genuinely useful behavioral fact: the OAuth scope requirement (subscriptions:read) and that it reads account data. It does not describe return shape or account-resolution 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 followed by the auth requirement. The opening sentence duplicates the title, so it is not perfectly waste-free, but overall it is tight.

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?

With no output schema, the description should ideally hint at what is returned (the bulk subscription update object), and it does not. For a simple read-by-ID tool with full schema coverage this is minimally adequate but leaves a gap.

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 three parameters (account, publication_id, bulk_subscription_update_id) are documented in the schema. The description adds nothing beyond that, which is the expected baseline when the schema carries the load.

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?

States the verb 'Get' and resource 'subscription update', but drops the 'bulk' qualifier that distinguishes this tool from the many subscription-related siblings (update_subscription, get_subscription, list_bulk_subscription_updates). It is essentially a restatement of the tool name with no clarifying scope.

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?

No indication of when to use this retrieval versus list_bulk_subscription_updates or the replace/update variants that share the same resource. The agent must infer the by-ID retrieval use case from the schema 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