Skip to main content
Glama

preview_wiki_page_update

Read-onlyIdempotent

REQUIRED first step of every wiki page update: validates the operations and returns the server-computed consequences (blocks added/removed/changed, files that would be permanently deleted, team discussions that would lose their anchors, possible-markdown warnings) plus the preview_token that update_wiki_page requires. Nothing is modified. Operations are block-addressed (replace_block / insert_after / delete_block / move_block) with AHM content — read get_ahm_spec first, and get block ids + document_version from show_wiki_page. Review the consequences before saving: a listed file deletion or discussion unanchoring is only acceptable when the user asked for it. Requires a Pro or trial workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPage path uid
operationsYesApplied in order against the evolving document
document_versionYesFrom show_wiki_page — proves freshness

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: 'Nothing is modified', it returns a preview_token required by update_wiki_page, it lists the specific consequences (blocks added/removed/changed, files permanently deleted, discussions losing anchors, markdown warnings), and it notes the Pro/trial workspace requirement. It doesn't contradict annotations. The only minor gap is not detailing the exact response shape, but with no output schema and rich behavioral disclosure, a 4 is appropriate.

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

Conciseness5/5

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

The description is dense but every sentence earns its place: it states the required-first-step role, lists the returned consequences, names the required token, clarifies non-mutation, gives the operation types and content format, names prerequisite tools, and states the workspace requirement. It is front-loaded with the most important usage constraint ('REQUIRED first step') and has no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a preview/validation tool with 3 fully documented parameters, no output schema, and annotations covering safety, the description is complete. It tells the agent what the tool returns (consequences + preview_token), what it doesn't do (nothing modified), what prerequisites are needed (get_ahm_spec, show_wiki_page), and when consequences are acceptable. Nothing an agent needs to call it correctly is missing.

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 100%, so the schema already documents all three parameters (id, document_version, operations) and their nested properties. The description adds context by explaining that operations are block-addressed with AHM content and that document_version comes from show_wiki_page, but it doesn't need to repeat schema details. Baseline 3 is correct when the schema does the heavy lifting.

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?

The description states a specific verb ('preview'), a specific resource ('wiki page update'), and its role as the REQUIRED first step. It distinguishes itself from update_wiki_page by explaining it validates operations and returns consequences plus a preview_token, and it names sibling tools (get_ahm_spec, show_wiki_page) for prerequisites. This clearly differentiates it from siblings like preview_description_update and update_wiki_page.

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

Usage Guidelines5/5

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

The description explicitly says when to use it: 'REQUIRED first step of every wiki page update' and 'Review the consequences before saving'. It also gives exclusions/conditions: 'a listed file deletion or discussion unanchoring is only acceptable when the user asked for it' and 'Requires a Pro or trial workspace'. It names alternatives/prerequisites: read get_ahm_spec first, get block ids + document_version from show_wiki_page. This is explicit when/when-not guidance.

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