pdm_ping

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

Discloses read-only nature, no state change, success response ('pong'), failure conditions (connection/auth), and config requirements ('Needs PROXIMO_PDM_* config'). No annotations to contradict.

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 front-load purpose and behavior, then add alternative and config note. No wasted 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?

Fully describes purpose, behavior, output, error handling, alternatives, and prerequisites. Simple tool made 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?

Schema description coverage is 100% for the sole parameter. Description adds no additional parameter meaning beyond schema, meeting baseline for high coverage.

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 explicitly states 'READ-ONLY: health check the PDM appliance' and distinguishes from sibling 'pdm_version' by noting it returns a simple 'pong' vs version details.

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?

Provides clear alternative (pdm_version) for version checks and implies use for basic connectivity testing, but does not explicitly state when not to use.

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