Skip to main content
Glama
dkanster
by dkanster

check_doc_page

Compare a cached documentation page with the live site to identify and report any differences.

Instructions

Compare a cached doc page with the live site and report differences

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesPage slug to check against live documentation
Behavior2/5

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

With no annotations provided, the description carries full burden for disclosing behavioral traits. It only states the high-level action (compare and report) but does not specify whether the tool is read-only, what kind of differences are detected, or any side effects. This is insufficient for safe invocation.

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 a single sentence with no unnecessary words. It is front-loaded with the action and resource, making it efficient for an agent to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite the tool's low complexity (1 param, no output schema), the description does not indicate the format of the output ('report differences' is vague). It omits details about pagination, thresholds, or error handling, leaving the agent with incomplete context.

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 single parameter 'slug' is described well in the input schema as 'Page slug to check against live documentation', and the description confirms its role. With 100% schema coverage, the description adds minimal but clear context, exceeding the baseline of 3.

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 purpose: comparing a cached doc page with the live site and reporting differences. The verb 'compare' and specific resources ('cached doc page' vs 'live site') make it distinct from sibling tools like get_doc_status or sync_documentation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. There is no mention of prerequisites, when-not-to-use, or which scenarios are appropriate. This leaves the agent without context for tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dkanster/mailganer-api-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server