Skip to main content
Glama
thenavidm
by thenavidm

Update a tier

replace_tier
Destructive

Updates an existing Beehiiv tier by changing its name, description, or prices; requires confirm=true because it changes account state.

Instructions

Update a tier. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require tiers:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
payloadNoComplete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
tier_idYesThe prefixed ID of the tier object
descriptionNo
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
prices_attributesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "prices_attributes": {
      +    "items": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "amount_cents": {
      +          "type": "integer"
      +        },
      +        "cta": {
      +          "type": "string"
      +        },
      +        "currency": {
      +          "enum": [
      +            "usd",
      +            "aud",
      +            "cad",
      +            "eur",
      +            "gbp",
      +            "inr",
      +            "brl",
      +            "mxn",
      +            "nzd",
      +            "dkk"
      +          ],
      +          "title": "TierPriceCurrency",
      +          "type": "string"
      +        },
      +        "delete": {
      +          "default": false,
      +          "description": "Optionally delete the price when updating the tier.",
      +          "type": "boolean"
      +        },
      +        "features": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "id": {
      +          "description": "ID of the existing price.",
      +          "pattern": "^(price_[0-9a-fA-F\\-]+)$",
      +          "title": "PriceId",
      +          "type": "string"
      +        },
      +        "interval": {
      +          "enum": [
      +            "month",
      +            "quarter",
      +            "year",
      +            "one_time",
      +            "donation"
      +          ],
      +          "title": "TierPriceInterval",
      +          "type": "string"
      +        },
      +        "interval_display": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "currency",
      +        "amount_cents",
      +        "interval"
      +      ],
      +      "title": "UpdateTierPriceRequest",
      +      "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 / payload / properties / prices_attributes / $ref
      Added value: +"#/$defs/prices_attributes"
    • removedInput schema / properties / payload / properties / prices_attributes / items
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "amount_cents": {
      -      "type": "integer"
      -    },
      -    "cta": {
      -      "type": "string"
      -    },
      -    "currency": {
      -      "enum": [
      -        "usd",
      -        "aud",
      -        "cad",
      -        "eur",
      -        "gbp",
      -        "inr",
      -        "brl",
      -        "mxn",
      -        "nzd",
      -        "dkk"
      -      ],
      -      "title": "TierPriceCurrency",
      -      "type": "string"
      -    },
      -    "delete": {
      -      "default": false,
      -      "description": "Optionally delete the price when updating the tier.",
      -      "type": "boolean"
      -    },
      -    "features": {
      -      "items": {
      -        "type": "string"
      -      },
      -      "type": "array"
      -    },
      -    "id": {
      -      "description": "ID of the existing price.",
      -      "pattern": "^(price_[0-9a-fA-F\\-]+)$",
      -      "title": "PriceId",
      -      "type": "string"
      -    },
      -    "interval": {
      -      "enum": [
      -        "month",
      -        "quarter",
      -        "year",
      -        "one_time",
      -        "donation"
      -      ],
      -      "title": "TierPriceInterval",
      -      "type": "string"
      -    },
      -    "interval_display": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "id",
      -    "currency",
      -    "amount_cents",
      -    "interval"
      -  ],
      -  "title": "UpdateTierPriceRequest",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / properties / prices_attributes / type
      Removed value: -"array"
    • addedInput schema / properties / prices_attributes / $ref
      Added value: +"#/$defs/prices_attributes"
    • removedInput schema / properties / prices_attributes / items
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "amount_cents": {
      -      "type": "integer"
      -    },
      -    "cta": {
      -      "type": "string"
      -    },
      -    "currency": {
      -      "enum": [
      -        "usd",
      -        "aud",
      -        "cad",
      -        "eur",
      -        "gbp",
      -        "inr",
      -        "brl",
      -        "mxn",
      -        "nzd",
      -        "dkk"
      -      ],
      -      "title": "TierPriceCurrency",
      -      "type": "string"
      -    },
      -    "delete": {
      -      "default": false,
      -      "description": "Optionally delete the price when updating the tier.",
      -      "type": "boolean"
      -    },
      -    "features": {
      -      "items": {
      -        "type": "string"
      -      },
      -      "type": "array"
      -    },
      -    "id": {
      -      "description": "ID of the existing price.",
      -      "pattern": "^(price_[0-9a-fA-F\\-]+)$",
      -      "title": "PriceId",
      -      "type": "string"
      -    },
      -    "interval": {
      -      "enum": [
      -        "month",
      -        "quarter",
      -        "year",
      -        "one_time",
      -        "donation"
      -      ],
      -      "title": "TierPriceInterval",
      -      "type": "string"
      -    },
      -    "interval_display": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "id",
      -    "currency",
      -    "amount_cents",
      -    "interval"
      -  ],
      -  "title": "UpdateTierPriceRequest",
      -  "type": "object"
      -}
    • removedInput schema / properties / prices_attributes / type
      Removed value: -"array"
  2. First observedv2.0.0

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is known. The description adds genuinely new context beyond that: it mutates account state and needs the tiers:write OAuth scope. It stops short of saying what the destructive path can remove (e.g. price deletion via prices_attributes.delete).

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 mutation/confirmation constraint leads and the auth requirement follows. Nothing is wasted, though it could be tighter by folding the auth note into the confirmation sentence.

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 a destructive, 9-parameter tool with nested price objects and no output schema, the description covers confirmation and auth but omits the replace-vs-update distinction from its sibling, the effect on existing prices, and any indication of partial vs full replacement. Adequate but with clear gaps.

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 67%, so the schema documents most parameters (account, confirm, payload, payload_file, tier_id, publication_id) already. The description only echoes confirm, adding no syntax or meaning beyond the schema's own text, which matches the baseline 3 for this coverage level.

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 a verb+resource ('Update a tier'), but the sibling list contains update_tier and create_tier, and the description never distinguishes replace_tier from update_tier or explains the replace/full-replacement semantics implied by the name. An agent cannot tell which tier-mutation tool to pick from this text alone.

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?

Gives one concrete precondition ('requires confirm=true for the user-requested action') and an auth requirement ('OAuth integrations require tiers:write'), which is useful. However, it offers no when-to-use guidance relative to update_tier, create_tier, or delete, so the routing decision remains implied.

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