novacrm_ping

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

With no annotations, the description carries the full burden: it correctly implies a read-only diagnostic and discloses that it exercises API-key authentication, which is useful pre-flight context. However, it says nothing about what a failure looks like, whether errors surface as tool errors versus a status payload, or about latency/rate-limit cost.

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 short sentences, front-loaded with the purpose and followed immediately by the operational instruction. Nothing is padded or restated from the name.

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 zero-parameter health check the core intent is covered, but with no output schema and no annotations the description should say what the call returns or how auth failure manifests, since that is the only thing an agent would call this tool to learn.

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?

The tool takes zero parameters, so the baseline is 4. The description correctly implies no inputs are needed and that credentials come from configuration rather than arguments, which is worth stating given the auth framing.

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?

States a specific verb and resource ('Testa a conectividade e a autenticação da chave de API') against a named system, NovaCRM. It is unmistakably distinct from every sibling, which all operate on CRM entities rather than on the connection 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?

'Use antes de qualquer outra ferramenta para validar a configuração' gives an explicit sequencing instruction relative to the 40+ sibling tools. It lacks a when-not clause (e.g., after a successful auth already established in the session), so it stops just short of full routing guidance.

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