pve_doctor

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

Describes it as read-only, checks connectivity and permissions, and reports gaps with privilege and role needed. Mentions 'preflight' implying no side effects. With no annotations, the description fully discloses behavior.

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?

Two sentences, front-loaded with key info ('READ-ONLY preflight'), and uses clear, efficient language with no unnecessary words.

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?

Tool is simple (1 optional param, no required). Description explains what it does and when to use it. Output schema exists, so return value details aren't needed. Complete for a diagnostic tool.

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?

Only one parameter, 'proximo_target', with a description in the schema covering its purpose. Schema coverage is 100%. The description does not add extra meaning beyond what the schema already provides.

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 it's a 'READ-ONLY preflight' that checks API connectivity and effective permissions, reporting what the token can and cannot do. It distinguishes itself from sibling tools by focusing on preflight/diagnostic for the API token itself.

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 'Run this FIRST after install to verify your config/token before wiring Proximo into an MCP client.' Provides clear when-to-use guidance. Does not list alternatives or when-not-to-use, but it's implied as a one-time setup check.

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