Skip to main content
Glama

Update document

update_document
DestructiveIdempotent

Replaces the Markdown body and/or title/description of a document. The previous version is kept as a revision. A published document changes publicly at once.

Input Schema

NameRequiredDescriptionDefault
langNoLanguage code, e.g. en, pl. Defaults to the site language.
siteNoSite domain, e.g. example.com (see list_sites). Optional when the account has one site.
slugYesDocument slug (see list_documents)
titleNo
markdownNo
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Beyond the annotations (destructiveHint=true, idempotentHint=true), the description adds two genuinely useful behavioral facts: the previous version is retained as a revision, and a published document changes publicly immediately. That materially softens the destructive flag and warns of a live side effect. It stops short of saying whether omitted fields are left untouched or cleared.

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?

Three short sentences: what changes, what is preserved, what the public impact is. The mutation and its scope are front-loaded with zero filler.

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 destructive 6-parameter mutation with no output schema, the description covers the essentials: what is replaced, revision retention, and immediate public effect. It is only missing return-value information (e.g., resulting revision identifier) and confirmation of partial-update semantics.

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 coverage is 50%: slug, site, and lang are documented in-schema while title, markdown, and description are bare. The 'and/or' wording usefully signals partial updates are allowed (matching slug as the only required parameter), but it doesn't define whether an omitted title/markdown clears the field or preserves it, nor any format constraints on markdown.

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?

It uses a specific verb ('Replaces') plus the exact resources modified (Markdown body, title, description) and scopes it to a single existing document. It implicitly separates itself from create_document and generate_document, though it never names a sibling explicitly.

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?

Usage is only implied: the agent can infer this is the tool for editing an existing document rather than creating one. There is no explicit guidance on when to use publish_document/unpublish_document alongside it, or on preconditions such as the document already existing.

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.