check_doc_changes

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

Describes the comparison mechanism, return format (grouped by status), and the effect of auto_rebuild. Discloses that without auto_rebuild it is read-only with no side effects. No contradictions.

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?

Concise, well-structured sentences. No wasted words; each sentence adds value. Front-loaded with purpose, followed by usage, mechanism, return, and parameter details.

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?

Completely describes what the tool does, when to use, mechanism, return value, and parameter behavior. Adequate for a single-parameter tool with no output schema.

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?

Input schema has 100% coverage with a clear description. The description adds usage context for the auto_rebuild parameter, justifying a score above baseline.

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 the tool checks for added, modified, or deleted documentation files since the last index build. It uses a specific verb and resource, and distinguishes from siblings like rebuild_index and search_project_docs.

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?

Explicitly says to use before search_project_docs to ensure index freshness or when user asks about changes. Also states it is safe without auto_rebuild, providing clear when-to-use and safety guidance.

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