Skip to main content
Glama

Update a published document

update_document
DestructiveIdempotent

Replace the contents or title of a document already published to SendPage. The share link stays exactly the same, so use this to fix a typo or update figures instead of publishing again — anyone who already has the link sees the correction.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
htmlNoReplacement HTML. Optional.
titleNoReplacement title. Optional.
shortIdYesThe document's id, the last part of its share link.
editTokenNoThe edit token returned when the document was published.

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already indicate destructiveHint and readOnlyHint false, and the description adds valuable behavioral context: the share link stays exactly the same and existing viewers see the correction. This goes beyond the annotation flags and helps the agent understand consequences without contradicting the annotations.

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?

Two sentences, front-loaded with the core verb and resource, and every sentence adds value: the first states the action, the second explains the share-link behavior and recommended use case. No 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 4-parameter tool with strong schema coverage and annotations present, the description sufficiently explains the purpose, key non-obvious behavior, and use scenario. It does not describe return values, but no output schema exists and this is not critical for an update operation.

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 baseline is 3. The description's mention of 'contents or title' maps to the html and title parameters, but it does not add additional meaning beyond what the schema already provides.

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 clearly uses the verb 'Replace' with the resource 'contents or title of a document already published to SendPage', and implicitly distinguishes itself from publish_document by emphasizing the same share link is retained. This makes the tool's purpose unambiguous and differentiated.

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 description explicitly states when to use this tool ('fix a typo or update figures') and provides a clear alternative behavior ('instead of publishing again'), which effectively tells the agent not to re-publish. It does not name the sibling publish_document explicitly, but the intent is clear.

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.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool targets a distinct operation: list, publish, or update documents. There is no overlap in purpose, making it clear which tool to select for a given action.

Naming Consistency5/5

All tool names follow the same verb_noun pattern (list_documents, publish_document, update_document), providing a predictable and consistent naming convention.

Tool Count4/5

With only 3 tools, the server is slightly minimal but well-scoped for a document publishing service. Each tool is essential and covers the core workflow without unnecessary bloat.

Completeness4/5

The set covers the primary lifecycle of publishing, updating, and listing documents. A delete operation is missing, but it is not critical for the server's apparent purpose, and the existing tools handle common use cases without dead ends.