Skip to main content
Glama
thenavidm
by thenavidm

Assign publication field values

publication_fields_values_update
Destructive

Assign or clear values for a publication field by its ID. Requires confirm=true and OAuth scope publication_fields:write.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
valuesNo
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.
publication_field_idYesThe prefixed ID of the publication field object

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "values": {
      +    "additionalProperties": {
      +      "type": "string"
      +    },
      +    "description": "The value each publication should resolve to, keyed by prefixed publication ID. A null or empty value clears the publication's own value.",
      +    "type": "object"
      +  }
      +}
    • 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 / values / $ref
      Added value: +"#/$defs/values"
    • removedInput schema / properties / payload / properties / values / additionalProperties
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / properties / values / description
      Removed value: -"The value each publication should resolve to, keyed by prefixed publication ID. A null or empty value clears the publication's own value."
    • removedInput schema / properties / payload / properties / values / type
      Removed value: -"object"
    • addedInput schema / properties / values / $ref
      Added value: +"#/$defs/values"
    • removedInput schema / properties / values / additionalProperties
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / values / description
      Removed value: -"The value each publication should resolve to, keyed by prefixed publication ID. A null or empty value clears the publication's own value."
    • removedInput schema / properties / values / type
      Removed value: -"object"
  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, readOnlyHint=false, and idempotentHint=false, so the safety profile is partly covered. The description adds genuinely new context beyond that: the confirm=true requirement and the OAuth scope publication_fields:write. It could still say more about what is destroyed or how non-idempotency manifests.

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 no filler, and the core purpose is front-loaded before the operational constraints. Efficient, though slightly abrupt.

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 mutation with a nested values object and no output schema, the description covers the confirmation and auth requirements but omits what happens to publications absent from the values map, the semantics of null/empty clearing (left to the schema), and any reversibility. Adequate but incomplete.

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 83%, so the schema already documents values, account, payload, payload_file, and confirm. The description's only parameter-level contribution is the confirm=true requirement, which is largely duplicative of the confirm schema description. Baseline 3 is appropriate.

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?

States a specific verb 'Assign' and resource 'publication field values', which distinguishes it from the read-only sibling publication_fields_values_index and the field-definition tool update_publication_field. It is clear but does not explicitly name or contrast those siblings.

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 notes the tool changes account state and requires confirm=true for a user-requested action, which implies when it is appropriate to call. However, it never says when to prefer this over update_publication_field or how it differs from the sibling field-value endpoints, so the routing guidance is only 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