Skip to main content
Glama
thenavidm

Beehiiv MCP Server

by thenavidm
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Create publication field

create_publication_field
Destructive

Create a custom publication field in Beehiiv to store and manage audience data like text, number, date, or URL values. Requires confirm=true for write actions and publication_fields:write for OAuth.

Instructions

Create publication field. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require publication_fields:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoThe type of value the field holds.
nameNo
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.
displayNoThe human readable label for the field.
payloadNoComplete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
endpoint_urlNoThe URL the value is retrieved from. Required when `value_source` is `fetched` and rejected otherwise. May contain merge tags that resolve per publication.
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
value_sourceNoWhere the value for each publication comes from. Defaults to `static`.
default_valueNoThe value used for publications that have not set one of their own. Required for every kind except `json` and `rss_feed_url`.
response_keysNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
+  "name": {
+    "description": "The merge tag key for the field, unique within the workspace. Derived from `display` when omitted. Normalized to start with a letter and contain only lowercase letters, numbers and underscores, so `Support Email` is stored as `support_email`. A `date` or `number` field also claims its format variants, so `launch_date_mdy` is rejected with `NAME_CLASHES` while a `date` field named `launch_date` exists, and the other way around.",
+    "type": "string"
+  },
+  "response_keys": {
+    "description": "The keys declared within the fetched JSON response body. Required when `kind` is `json` and rejected otherwise. A `number` or `date` key also claims its format variants, so a key `temp_round2` is rejected with `RESPONSE_KEYS_CLASHES` beside a `number` key named `temp`.",
+    "items": {
+      "additionalProperties": false,
+      "properties": {
+        "key": {
+          "description": "The name of the key within the JSON response body.",
+          "type": "string"
+        },
+        "kind": {
+          "description": "The type of value the key holds.",
+          "enum": [
+            "text",
+            "number",
+            "date",
+            "url",
+            "image_url"
+          ],
+          "title": "PublicationFieldResponseKeyKind",
+          "type": "string"
+        }
+      },
+      "required": [
+        "key",
+        "kind"
+      ],
+      "title": "PublicationFieldResponseKey",
+      "type": "object"
+    },
+    "type": "array"
+  }
+}
    • 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 / name / $ref
      Added value: +"#/$defs/name"
    • removedInput schema / properties / name / description
      Removed value: -"The merge tag key for the field, unique within the workspace. Derived from `display` when omitted. Normalized to start with a letter and contain only lowercase letters, numbers and underscores, so `Support Email` is stored as `support_email`. A `date` or `number` field also claims its format variants, so `launch_date_mdy` is rejected with `NAME_CLASHES` while a `date` field named `launch_date` exists, and the other way around."
    • removedInput schema / properties / name / type
      Removed value: -"string"
    • addedInput schema / properties / payload / properties / name / $ref
      Added value: +"#/$defs/name"
    • removedInput schema / properties / payload / properties / name / description
      Removed value: -"The merge tag key for the field, unique within the workspace. Derived from `display` when omitted. Normalized to start with a letter and contain only lowercase letters, numbers and underscores, so `Support Email` is stored as `support_email`. A `date` or `number` field also claims its format variants, so `launch_date_mdy` is rejected with `NAME_CLASHES` while a `date` field named `launch_date` exists, and the other way around."
    • removedInput schema / properties / payload / properties / name / type
      Removed value: -"string"
    • addedInput schema / properties / payload / properties / response_keys / $ref
      Added value: +"#/$defs/response_keys"
    • removedInput schema / properties / payload / properties / response_keys / description
      Removed value: -"The keys declared within the fetched JSON response body. Required when `kind` is `json` and rejected otherwise. A `number` or `date` key also claims its format variants, so a key `temp_round2` is rejected with `RESPONSE_KEYS_CLASHES` beside a `number` key named `temp`."
    • removedInput schema / properties / payload / properties / response_keys / items
      Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "key": {
-      "description": "The name of the key within the JSON response body.",
-      "type": "string"
-    },
-    "kind": {
-      "description": "The type of value the key holds.",
-      "enum": [
-        "text",
-        "number",
-        "date",
-        "url",
-        "image_url"
-      ],
-      "title": "PublicationFieldResponseKeyKind",
-      "type": "string"
-    }
-  },
-  "required": [
-    "key",
-    "kind"
-  ],
-  "title": "PublicationFieldResponseKey",
-  "type": "object"
-}
    • removedInput schema / properties / payload / properties / response_keys / type
      Removed value: -"array"
    • addedInput schema / properties / response_keys / $ref
      Added value: +"#/$defs/response_keys"
    • removedInput schema / properties / response_keys / description
      Removed value: -"The keys declared within the fetched JSON response body. Required when `kind` is `json` and rejected otherwise. A `number` or `date` key also claims its format variants, so a key `temp_round2` is rejected with `RESPONSE_KEYS_CLASHES` beside a `number` key named `temp`."
    • removedInput schema / properties / response_keys / items
      Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "key": {
-      "description": "The name of the key within the JSON response body.",
-      "type": "string"
-    },
-    "kind": {
-      "description": "The type of value the key holds.",
-      "enum": [
-        "text",
-        "number",
-        "date",
-        "url",
-        "image_url"
-      ],
-      "title": "PublicationFieldResponseKeyKind",
-      "type": "string"
-    }
-  },
-  "required": [
-    "key",
-    "kind"
-  ],
-  "title": "PublicationFieldResponseKey",
-  "type": "object"
-}
    • removedInput schema / properties / response_keys / type
      Removed value: -"array"
  2. First observedv2.0.0

TDQS

A3.6/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 readOnlyHint=false, so the mutation profile is covered. The description adds value the annotations cannot: the confirm=true safety gate and the OAuth scope requirement (publication_fields:write). It stops short of saying what state is changed or whether the created field is returned.

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 immediately by the two constraints that matter. The only waste is the opening sentence, which duplicates the title field and could be dropped without information loss.

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 an 11-parameter, zero-required, deeply nested mutation tool with no output schema, the description covers the safety and auth dimensions but nothing about the payload/file/body-flag mutual exclusivity or what the call returns. The rich schema compensates for most parameter gaps, leaving this adequate but thin.

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 82%, so the schema already documents confirm, kind, name, payload, value_source and the rest in detail. The description only echoes the confirm requirement and adds no syntax or semantics for the other ten parameters (e.g., payload vs body-flag exclusivity). Baseline 3 applies.

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 concrete verb+resource (create a publication field), which is unambiguous about what operation is performed. However, the first sentence is essentially a verbatim restatement of the tool title, and it offers no differentiation from nearby siblings like update_publication_field or create_custom_field. Clear but not distinguishing.

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 real usage gate: confirm=true is required, and the user must have asked for exactly this action. But it never names an alternative tool (update_publication_field, get_publication_field, create_custom_field) or states when not to use it beyond the confirmation gate. Usage is implied rather than routed.

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