qgis_ping

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

Describes the behavior: checking QGIS status and returning version info. No annotations are present, so the description fully carries the burden. It is clear that the tool is read-only and non-destructive, though it does not mention potential network timeouts or authentication.

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: first states the purpose, the second adds usage guidance and output details. Every word is informative, no waste, and the key information is front-loaded.

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?

For a simple ping tool with no parameters, the description fully covers what it does, when to use it, and what it returns. No additional details are necessary given the tool's simplicity and the presence of an output schema.

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 schema coverage is trivially 100%. The description adds meaning by explaining the tool's purpose and output, meeting the baseline expectation for zero-parameter tools.

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?

Clearly states the tool checks that QGIS is running with MCP plugin enabled and returns versions. It is a health check tool, but does not explicitly differentiate from siblings; however, the purpose is distinct from other QGIS operations.

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 to use this tool first if any other tool fails, providing crucial guidance on when to use and how to interpret failures (differentiates between connectivity issues and real errors).

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