Skip to main content
Glama

validate_content

Scan documentation for broken links, code syntax errors, and reference accuracy to ensure quality and reliability.

Instructions

Validate general content quality: broken links, code syntax, references, and basic accuracy

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentPathYesPath to the content directory to validate
validationTypeNoType of validation: links, code, references, or allall
includeCodeValidationNoWhether to validate code blocks
followExternalLinksNoWhether to validate external URLs (slower)
Behavior2/5

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

No annotations provided, so the description must disclose behavior. It only lists validation types but does not mention if the tool is read-only, if it modifies content, or what the output format is. This is insufficient for an agent to understand side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one concise sentence, front-loaded with the key purpose. No wasted words, but could be slightly expanded to include behavior or usage context without losing conciseness.

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?

Given no output schema and no annotations, the description is brief. It covers basic purpose but lacks details on return values, performance implications (e.g., following external links is flagged as slower in the param description but not in the tool description), and differentiation from siblings. Adequate for simple use but not comprehensive.

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 each parameter's meaning is already clear. The description adds a summary of validation types but does not elaborate beyond the schema. Baseline 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 validates content quality including specific aspects (broken links, code syntax, references, basic accuracy). It distinguishes itself from sibling tools like 'check_documentation_links' which is link-specific, and 'validate_documentation_freshness' which targets freshness.

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 on when to use this tool versus alternatives. With numerous sibling tools like 'check_documentation_links' and 'validate_documentation_freshness', the description should specify context or exclusions but does not.

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/tosin2013/documcp'

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