Skip to main content
Glama

validate_documentation

Check Doxygen documentation for warnings, identify missing documentation, and analyze coverage to improve code documentation quality.

Instructions

Check for documentation warnings, missing docs, and coverage analysis

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_pathYes
check_coverageNo
warn_undocumentedNo
output_formatNotext

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions what the tool checks but doesn't describe how it behaves—e.g., whether it's read-only, requires specific permissions, has side effects, or handles errors. For a tool with 4 parameters and no annotation coverage, this is a significant gap in transparency.

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 extremely concise and front-loaded, consisting of a single, efficient sentence: 'Check for documentation warnings, missing docs, and coverage analysis.' Every word contributes directly to the tool's purpose without any fluff or redundancy, making it easy to parse quickly.

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 the tool's moderate complexity (4 parameters, 1 required) and the presence of an output schema, the description is minimally adequate. It states the core function but lacks details on behavior, parameters, and usage context. The output schema helps by defining return values, but the description doesn't fully address gaps in annotations and parameter semantics, making it incomplete for optimal agent understanding.

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

Parameters2/5

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

Schema description coverage is 0%, meaning none of the 4 parameters have descriptions in the schema. The tool description doesn't add any parameter-specific information beyond the high-level purpose. It doesn't explain what 'project_path' should be, what 'check_coverage' entails, or how 'output_format' affects results, failing to compensate for the schema's lack of detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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: 'Check for documentation warnings, missing docs, and coverage analysis.' It specifies the verb 'check' and the resources (documentation warnings, missing docs, coverage analysis), making the function understandable. However, it doesn't explicitly differentiate from sibling tools like 'scan_project' or 'generate_documentation', which might have overlapping purposes, so it falls short of a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives. With sibling tools such as 'scan_project' and 'generate_documentation' available, there's no indication of context, prerequisites, or exclusions. This lack of comparative information leaves the agent to infer usage, which is insufficient for effective 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/Positronikal/doxygen-mcp'

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