Skip to main content
Glama
thenavidm
by thenavidm

Get subscription by email

get_subscription_by_email
Read-onlyIdempotent

Look up a Beehiiv subscription using a publication ID and email address, returning subscriber status, stats, tags, custom fields, or referrals as needed.

Instructions

Get subscription by email. Reads account data. OAuth integrations require subscriptions:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailYesThe ID of the subscriber object
expandNoOptional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with. `referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription. `stats` - Returns statistics about the subscription(s). `custom_fields` - Returns an array of custom field values that have been set on the subscription. `tags` - Returns an array of tags that have been set on the subscription. `newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to.
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
publication_idYesThe prefixed ID of the publication 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, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds genuine value by stating the required OAuth scope ('subscriptions:read') and that it reads account data, but it says nothing about behavior on a missing subscription or whether the lookup is case-sensitive on email.

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, front-loaded sentences with no filler. The first sentence is redundant with the name, but the auth scope is placed clearly at the end where an agent will find it. Efficient overall.

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 carries more burden than it does: it never indicates what the subscription object contains or what happens when no match exists. For a simple read tool whose annotations cover the safety profile, the auth scope note makes it minimally adequate but not 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 and the schema does the heavy lifting. The description adds no parameter meaning at all, and notably does not correct the misleading schema description for 'email' ('The ID of the subscriber object'), which conflicts with the tool's email-lookup intent.

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 repeats the tool name almost verbatim ('Get subscription by email'), so it adds little beyond what the name/title already convey. It does implicitly signal the lookup key (email) which loosely distinguishes it from the sibling get_subscription, but no sibling is named or contrasted. This lands as a vague restatement rather than a sharpened purpose.

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?

There is no when-to-use or when-not-to-use guidance, and no alternatives named (e.g., get_subscription vs. this email-based lookup, or list_subscriptions for enumerating). The only context given is an auth scope, which is a prerequisite rather than usage guidance.

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