Skip to main content
Glama

Check a document before sending

check_document
Read-only

Check an HTML document for the problems a recipient will notice and you cannot: links that lead nowhere, images that will not load, placeholder text left in, http:// references the viewer blocks. Call this BEFORE handing someone a share link — a hallucinated URL or a dead CDN image is invisible while writing and obvious when reading. Pass html to check a draft, or shortId to re-check something already published after fixing it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
htmlNoA draft to check before publishing. Use this or `shortId`.
shortIdNoAn already-published document to check. Use this or `html`.
editTokenNoThe edit token, if this key did not publish the document.

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds valuable context about what the check covers and the key insight that certain problems are invisible during writing but obvious when reading. It doesn't detail output format or rate limits, but given annotation coverage, the extra context pushes it above baseline.

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 sentences with a clear structure: what it checks, when to call it, and which parameter to pass. Every sentence earns its place, and the key action is front-loaded in the first sentence. No fluff or repetition.

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 read-only check tool with complete schema and annotations, the description covers the action, timing, and parameter selection well. The only gap is no explanation of the return value (e.g., whether it returns a list of problems), but since it's a check tool, the output is somewhat implicit and not critical for invocation decisions.

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

Parameters4/5

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

The schema provides 100% parameter coverage with clear descriptions for html, shortId, and editToken. The description adds meaning by explaining when to use html (draft) vs shortId (already-published), which clarifies the primary selection logic. It doesn't explain editToken, but the schema already handles that, so the description adds a modest bonus.

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 action ('check an HTML document') with a concrete resource type and lists the exact problem classes it catches (dead links, broken images, placeholder text, blocked http:// references). It clearly differentiates from siblings like get_document (retrieval) or publish_document (publishing) by focusing on pre-send validation.

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 gives explicit timing guidance: 'Call this BEFORE handing someone a share link.' It also clarifies the two primary input modes (html for drafts, shortId for already-published docs). While it doesn't name specific sibling tools as alternatives, the context makes the intended use clear, so it's slightly below the highest bar.

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.