Skip to main content
Glama

validate_diataxis_content

Validate the accuracy, completeness, and compliance of Diataxis documentation against specified criteria.

Instructions

Validate the accuracy, completeness, and compliance of generated Diataxis documentation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentPathYesPath to the documentation directory to validate
analysisIdNoOptional repository analysis ID for context-aware validation
validationTypeNoType of validation: accuracy, completeness, compliance, or allall
includeCodeValidationNoWhether to validate code examples
confidenceNoValidation confidence level: strict, moderate, or permissivemoderate
Behavior2/5

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

Without annotations, the description provides no behavioral details beyond 'validate'. It doesn't disclose return format, side effects, or what happens on failure. For a validation tool, this is a significant gap.

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?

Single, concise sentence with no redundant words. It efficiently conveys the tool's purpose without fluff.

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

Completeness2/5

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

With 5 parameters and no output schema, the description omits critical context: what the tool returns (a report? errors?), and how results are presented. Given the rich set of sibling tools, more completeness is needed for correct agent usage.

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 the schema already documents each parameter. The description adds no extra meaning beyond the schema's descriptions, earning baseline 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 verb 'validate' and the resource 'Diataxis documentation', specifying three distinct aspects (accuracy, completeness, compliance). This distinguishes it from sibling tools like 'validate_content' which is more generic.

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 compared to siblings such as 'validate_content', 'check_documentation_links', or 'evaluate_readme_health'. The agent gets no help in choosing among validation-related tools.

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