pmg_doctor

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

Explicitly marks as READ-ONLY, describes endpoints called, return dict keys, and what a successful call proves. With no annotations provided, the description fully covers behavioral traits without contradiction.

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?

Three sentences with front-loaded purpose. No superfluous content. Highly efficient.

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?

Complete for a diagnostic tool: input schema fully covers parameters, output schema described in description, behavior and usage guidance provided. No gaps.

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?

Schema coverage is 100%, so baseline is 3. Description does not add additional parameter meaning beyond what the schema already provides; it merely restates the environment requirement.

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?

Description clearly states the tool is for PMG connectivity and credential preflight, checking /version and /access/users endpoints. It distinguishes from sibling tools by advising to run this first before other pmg_* tools.

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?

Explicit when-to-use guidance: 'Run this first when diagnosing PMG trouble, before other pmg_* tools.' Also states prerequisite (PROXIMO_PMG_* config) and clarifies a common confusion (PMG has no /access/permissions endpoint).

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