Skip to main content
Glama

plan_draft_update

Read-only

Preview proposed Markdown and metadata changes against an unpublished draft, check conversion losses and preflight, then get a receipt to safely apply updates without writing.

Instructions

Read an unpublished draft and review proposed Markdown/metadata changes, bounded previews, conversion losses and preflight. Returns a receipt binding the observed state and exact payload for update_draft. No writes. Hashes check consistency, not human approval; stale detection is best-effort, not atomic.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
titleNo
audienceNo
draft_idYes
subtitleNo
allow_unsupportedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
changesYes
receiptYes
preflightYes
editor_urlYes
limitationsYes
changed_fieldsYes
format_versionYes
scheduling_policyYes
unsupported_nodesYes
proposed_markdown_previewYes
markdown_preview_truncatedYes
scheduling_fields_not_returnedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior5/5

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

The description goes well beyond the readOnlyHint annotation by adding 'No writes,' explaining the receipt binding observed state, and disclosing limitations: 'Hashes check consistency, not human approval; stale detection is best-effort, not atomic.' This is strong behavioral context that helps an agent trust and interpret the result.

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?

The description is compact and front-loaded with the core purpose in the first sentence. Each sentence adds value, though the list 'bounded previews, conversion losses and preflight' is jargon-heavy and slightly awkward.

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?

The safety profile, no-write guarantee, receipt semantics, and consistency caveats are well covered, and an output schema exists to describe return values. However, with 6 parameters and zero schema descriptions, the lack of parameter guidance is a real gap, and the relationship to preflight_draft is left implicit.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the burden of explaining parameters, but it never mentions draft_id, allow_unsupported, audience, or subtitle. 'Markdown/metadata changes' loosely hints at body/title/subtitle but doesn't clarify the important flags or defaults.

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 clearly states it reads/reviews an unpublished draft and proposed Markdown/metadata changes, and it distinguishes itself from update_draft by explicitly saying 'No writes' and returning a receipt for update_draft. However, the word 'preflight' overlaps with the sibling preflight_draft, so it doesn't fully separate itself from that tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'exact payload for update_draft' plus 'No writes' establishes clear context that this is a planning/preview step before updating a draft. It doesn't provide explicit when-not guidance or name alternatives such as preflight_draft or get_draft.

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