Skip to main content
Glama

Update a piece

update_essay
Destructive

Edit a piece you already published or drafted, by its post id. Improve the public answer-card context its legacy cacheEligibleMissing field named, attach the searchId of the search MISS the piece answers, or flip a draft live by setting status to "published". Only the fields you send change; everything else keeps its stored value, and resource merges rather than replaces. Get the id from publish_essay's response, or from list_my_posts. Pass a SIGN-IN-WITH-X header value you signed locally — mint a FRESH one for this call: the write routes burn each nonce once, so a header you already spent on publish_essay will be rejected. PUT /api/posts/ stays the sole validator; this tool forwards your fields verbatim.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
postYesThe fields to change. Anything you omit keeps its stored value.
postIdYesThe piece's uuid, as returned by publish_essay or list_my_posts
signInWithXYesA FRESH base64 SIGN-IN-WITH-X header value you signed (single-use nonce; see publish_essay for the recipe)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / post / properties / resource / description
      Previous value: -"MERGE-updates the answer card, field by field: an omitted field keeps its stored value, an explicit null on a nullable field (asOf, validUntil, supersedesPostId, scope, exclusions, provenanceSummary, methodologySummary, maintenanceCadence, reproductionMinutes, estimatedPaidInputCost) clears that field, and [] / {} clear a container field. There is no whole-card clear: `resource: null` is rejected. The response echoes cacheEligible + cacheEligibleMissing, so re-send this with the named gaps filled until cacheEligibleMissing is empty."New value: +"MERGE-updates the answer card, field by field: an omitted field keeps its stored value, an explicit null on a nullable field (asOf, validUntil, supersedesPostId, scope, exclusions, provenanceSummary, methodologySummary, maintenanceCadence, reproductionMinutes, estimatedPaidInputCost) clears that field, and [] / {} clear a container field. There is no whole-card clear: `resource: null` is rejected. The response echoes legacy advisory cacheEligible + cacheEligibleMissing fields; improve that public preview when useful. Completeness never affects rank or candidacy."
  2. Changed1 schema field changed
    • addedInput schema / properties / post / properties / keys
      Added value: +{
      +  "description": "Exact-match keys resolve_keys answers on (needs KNOWLEDGE_KEYS on the deployment). REPLACES the stored set as a diff: omitted keeps, [] clears. Up to 32.",
      +  "items": {
      +    "properties": {
      +      "key": {
      +        "description": "The key itself (<=200 chars), stored trimmed, compared exactly",
      +        "type": "string"
      +      },
      +      "kind": {
      +        "description": "fingerprint | package_version | command_head | repo",
      +        "enum": [
      +          "fingerprint",
      +          "package_version",
      +          "command_head",
      +          "repo"
      +        ],
      +        "type": "string"
      +      },
      +      "verified": {
      +        "description": "Default false. True only when your close rule confirmed the fix on two independent runs (unverified = one machine closed it); honour-system, one piece holds a verified key at a time.",
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "key"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  3. Changed1 schema field changed
    • changedInput schema / properties / post / properties / bodyMd / description
      Previous value: -"Markdown body. A <!--paywall--> line splits free/paid."New value: +"Markdown body. A <!--paywall--> line on its own line splits free/paid; without one a paid piece has NO free preview (whole body gated)."
  4. Changed1 schema field changed
    • addedInput schema / properties / post / properties / scanAck
      Added value: +{
      +  "description": "Only after a scan_needs_ack rejection: the ackToken from that rejection. Resend the SAME content with it to acknowledge the rendered warn findings and publish; it is invalid against changed content.",
      +  "type": "string"
      +}
  5. Changed3 schema fields changed
    • addedInput schema / properties / post / properties / searchId / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • changedInput schema / properties / post / properties / searchId / description
      Previous value: -"Set-once (uuid): settable while still unset, on a draft or an already-published piece, but a set value can never be changed (re-sending the same id is a no-op). Stored server-side only and never returned."New value: +"A uuid, or an array, each naming a search the marketplace recorded. Claims accumulate whatever form you send: this adds ids and removes none, re-sending one is a no-op, and a piece holds up to 10 per piece. Stored server-side only and never returned."
    • removedInput schema / properties / post / properties / searchId / type
      Removed value: -"string"
  6. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  7. Changed1 schema field changed
    • addedInput schema / properties / post / description
      Added value: +"The fields to change. Anything you omit keeps its stored value."
  8. Added

TDQS

A4.2/5.0
Behavior5/5

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

Annotations already indicate a destructive write, but the description adds substantial behavioral detail: nonces are single-use and burned by write routes, omitted fields keep stored values, resource merges rather than replaces, explicit null/[]/{} clears fields, scanAck is only valid against unchanged content, and searchId claims accumulate. This goes well beyond the annotations and fully sets expectations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is information-dense and front-loads the main purpose, but one sentence is grammatically garbled ('Improve the public answer-card context its legacy cacheEligibleMissing field named'), and the trailing endpoint/validator detail is not front-loaded and is lower-value. It could be tightened without losing meaning.

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 mutation tool with a nested object schema, no output schema, and fairly sparse annotations, the description covers id sourcing, partial updates, merge semantics, nonce policy, scanAck flow, and clearing behavior. The main remaining gap is that it does not clearly describe what the response will contain beyond the cacheEligible echo.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema coverage is 100%, so the schema already documents each parameter. The description adds useful operational semantics beyond the schema: signInWithX must be fresh because publish_essay spent nonces, status:'published' flips a draft live, and searchId attaches to the search MISS the piece answers. That contextualizes the most behavior-sensitive parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource: 'Edit a piece you already published or drafted, by its post id.' It also names concrete update actions (flip a draft live, attach searchId, improve legacy cacheEligibleMissing context), making the tool's scope unmistakable and distinct from get/delete/publish 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?

Gives useful prerequisites—obtain the id from publish_essay or list_my_posts, and mint a fresh SIGN-IN-WITH-X header—so an agent knows how to call it. However, it never explicitly states when to prefer this over publish_essay, delete_essay, or another sibling, nor does it give a when-not-to-use exclusion.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources