frappe_ping

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

Discloses that it checks reachability, authentication, and responsiveness. Without annotations, the description carries the burden and adequately describes the tool's behavior. However, it does not detail the pong response format or potential error conditions, which would enhance transparency.

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 three sentences, front-loading the main action. Every sentence adds value: purpose, detail, and usage guidance. No wasted words, appropriately sized for the tool's simplicity.

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 zero parameters and no output schema, the description covers essential aspects: purpose, outcome, and usage advice. Lacks potential failure case details (e.g., network errors) but is sufficient for a simple health-check 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?

No parameters exist, so the description does not need to add param semantics. The schema is fully covered with no properties. The baseline for 0 parameters is 4, and the description adds no unnecessary info.

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 connectivity to a Frappe/ERPNext site and returns a pong response. It distinguishes itself from sibling CRUD and method execution tools by being a dedicated health-check.

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 advises using this as a health-check before making other calls, providing clear when-to-use guidance. The recommendation to verify connection before other operations is direct and helpful.

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