Skip to main content
Glama

Check a paywall document without saving it

validate_paywall_doc
Read-only

Runs a document through the same parser and renderer a save uses and reports what is wrong, if anything. Changes nothing.

Input Schema

NameRequiredDescriptionDefault
docYesA paywall document (version: 1)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/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 safety is covered. The description adds valuable context beyond that: it validates using the same parser and renderer as a save and reports what is wrong, clarifying that it mirrors real save behavior without mutating.

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 compact sentences that front-load the core behavior and end with the key non-mutating guarantee. No wasted words.

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 simple single-parameter validation tool with no output schema, the description is largely complete: it explains what is checked and that nothing changes. It could be slightly richer by hinting at the return shape (e.g., list of errors vs. a boolean), but annotations already carry the safety profile.

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 100%, so the single 'doc' parameter is already documented in the schema as 'A paywall document (version: 1)'. The description adds no further parameter-level detail, which is acceptable given the high coverage baseline.

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?

States a specific verb (validate) and resource (paywall document) with precise mechanics: it runs the document through the same parser and renderer a save uses. This clearly distinguishes it from save_paywall_doc and validate_onboarding_doc.

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?

Implies usage before saving by saying it uses the same parser and renderer a save does, and 'Changes nothing' signals it is a safe pre-check. However, it does not explicitly name save_paywall_doc or say when not to use it, leaving the alternative selection slightly implicit.

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