docmgr_validate_docs

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

Annotations already provide readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds that it is 'Read-only (only analyzes documentation)' and notes that validate_code_syntax is 'slower'. This provides useful behavioral context beyond the annotations.

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

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

The description is concise and well-structured with sections for usage, result, mode, optional checks, and workflow. Every sentence adds value, and there is no redundancy or wasted text.

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

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

Given 7 parameters, 1 required, 0% schema descriptions, and an output schema, the description covers the main checks and the result format. It could be more explicit about the path parameters, but it provides sufficient context for effective use.

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

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

The schema has 0% description coverage. The description compensates by explaining each optional boolean check (e.g., 'Validate internal links', 'Verify images/assets exist'). However, it does not elaborate on the project_path or docs_path parameters, which could benefit from additional clarity.

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

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Validate documentation for broken links, missing assets, code snippet syntax, and convention compliance.' It uses a specific verb and resource, listing distinct validation categories. This differentiates it from sibling tools like docmgr_assess_quality or docmgr_detect_changes.

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

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

The description explicitly provides usage scenarios: 'Use when: Before releases, after major doc updates, or as part of CI/CD' and mentions a typical workflow. While it does not explicitly mention alternatives, the context implies when to use this tool over others.

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