Skip to main content
Glama

Read a published document back

get_document
Read-onlyIdempotent

Fetch the current HTML of a document you published, so it can be edited rather than rewritten. Call this before update_document: acting on feedback usually means one small change, and regenerating the whole file loses everything else about it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shortIdYesThe document's id, the last part of its share link.
editTokenNoThe edit token, if this key did not publish the document.

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds valuable context beyond annotations by specifying the return type ('current HTML') and the behavioral benefit of editing rather than regenerating. It does not contradict 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?

The description is two sentences, front-loaded with the action, and every sentence earns its place. It conveys purpose, usage context, and rationale without any 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?

Given the low complexity, rich annotations, and 100% schema coverage for the two parameters, the description is sufficiently complete for selecting and invoking the tool. It specifies the return type ('current HTML') and the recommended call pattern ('before update_document'), which is all the agent needs to use it correctly.

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%, with both shortId and editToken clearly described in the input schema. The description does not add additional parameter-level semantics beyond the schema, so the baseline score of 3 is appropriate.

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 states the tool's function with a specific verb and resource: 'Fetch the current HTML of a document you published.' It distinguishes itself from sibling tools by framing the output as editable rather than something to rewrite, and explicitly names update_document as the paired next step.

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 gives explicit usage guidance: 'Call this before update_document' and explains why, noting that 'regenerating the whole file loses everything else about it.' This clearly communicates when to use the tool and the reasoning behind the recommended workflow.

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.