Skip to main content
Glama
thenavidm

Beehiiv MCP Server

by thenavidm
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Add subscription to an automation

add_subscriber_to_automation
Destructive

Add a subscriber to a Beehiiv automation by publication and automation IDs; requires confirm=true and automations:write OAuth scope.

Instructions

Add subscription to an automation. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require automations:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoThe email address associated with the subscription.
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.
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
automation_idYesThe prefixed ID of the automation object
publication_idYesThe prefixed ID of the publication object
subscription_idNoThe prefixed ID of the subscription.
double_opt_overrideNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
+  "DoubleOptOverride": {
+    "description": "Override the publication's default double opt-in settings for this subscription. Possible values are: - \"on\" : The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - \"off\" : The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - \"not_set\" : The publication's default double opt-in settings will be applied to this subscription.",
+    "title": "DoubleOptOverride",
+    "type": "string"
+  }
+}
    • 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."
    • addedInput schema / properties / double_opt_override / $ref
      Added value: +"#/$defs/DoubleOptOverride"
    • removedInput schema / properties / double_opt_override / description
      Removed value: -"Override the publication's default double opt-in settings for this subscription. Possible values are: - \"on\" : The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - \"off\" : The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - \"not_set\" : The publication's default double opt-in settings will be applied to this subscription."
    • removedInput schema / properties / double_opt_override / title
      Removed value: -"DoubleOptOverride"
    • removedInput schema / properties / double_opt_override / type
      Removed value: -"string"
    • addedInput schema / properties / payload / properties / double_opt_override / $ref
      Added value: +"#/$defs/DoubleOptOverride"
    • removedInput schema / properties / payload / properties / double_opt_override / description
      Removed value: -"Override the publication's default double opt-in settings for this subscription. Possible values are: - \"on\" : The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - \"off\" : The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - \"not_set\" : The publication's default double opt-in settings will be applied to this subscription."
    • removedInput schema / properties / payload / properties / double_opt_override / title
      Removed value: -"DoubleOptOverride"
    • removedInput schema / properties / payload / properties / double_opt_override / type
      Removed value: -"string"
  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?

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds context the annotations do not carry: that it changes account state, that confirm=true is gated on an explicit user request, and that OAuth integrations need automations:write. It does not say whether the change is reversible or how a subscriber already in the automation is handled.

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 with the mutation and the confirm precondition front-loaded before the auth requirement. The opening sentence largely restates the title, which is the only wasted text, but overall there is no padding.

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 9-parameter mutation with a nested payload object and no output schema, the description covers the two things an agent could not infer from structured fields: the confirm gate and the required OAuth scope. The mutual exclusivity of payload, payload_file and body flags is handled by the schema descriptions, so the gap is small.

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 89%, so the schema already documents the id patterns, email, account, payload, payload_file and double_opt_override fields. The description only surfaces 'confirm', which the schema also explains. Baseline 3 is appropriate when the schema carries nearly all parameter meaning.

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: adding a subscription to an automation, which is unambiguous about the operation. However, it does not distinguish this from adjacent siblings such as create_subscription or update_subscription, so an agent gets no routing help beyond the name itself.

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?

It gives one concrete precondition ('requires confirm=true for the user-requested action') and notes the OAuth scope needed, which is real usage guidance. It stops short of saying when this tool is the right choice versus create_subscription or the various update_subscription variants, so the when-to-use-vs-alternative question is left to inference.

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