doctor

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

The description discloses the read-only vs. repair behavior, but lacks details on what repairs entail, side effects, or reversibility. With no annotations provided, this is adequate but not comprehensive.

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 (two lines), front-loads the purpose, and avoids waste. Every sentence adds value.

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 the tool's diagnostic nature, the description covers key aspects, but it does not mention return values or output, even though an output schema exists. It is minimally complete.

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 description explains the 'action' parameter (default read-only, 'fix' repairs), adding value over the schema. However, the 'help' parameter is not described, and schema coverage is 0%, so the description partially compensates.

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 project data integrity and lists specific aspects (oldId/newId, files[] paths, link targets). It distinguishes between default read-only diagnostics and a fix action, setting it apart from siblings like status or cleanup.

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 explains when to use each mode (default for checks, action='fix' for repairs) but does not explicitly exclude alternatives or mention prerequisites.

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