test_connection

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

With no annotations, the description carries the full burden. It usefully discloses that the check traverses the ssh tunnel and that the response contains server version and latency, but says nothing about failure behavior (error vs. negative result), authentication needs, or timeout characteristics for what is inherently a network round trip.

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 verb and resource, with the scope qualifier and return payload following. No filler text.

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, one-parameter read-only diagnostic tool with no output schema, the description conveys what is checked and roughly what comes back. The only real omission is disambiguating the 'name' parameter and stating what a failed test looks like.

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 single required parameter 'name' has 0% schema description coverage and the description never clarifies whether it is a stored connection identifier, a host, or a URI. The description mentions 'an ES connection' only obliquely, so the agent must guess which value to supply.

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 (verify) and resource (an ES connection), plus the end-to-end scope including the ssh tunnel. None of the sibling tools (update/list/add/remove_connection, the es_* operations) perform this check, so an agent can select it unambiguously.

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?

The nature of the call implies usage (confirm a connection is healthy, e.g. after add_connection or before es_search), but the description never states when to use it versus es_cluster_health or when not to bother. No prerequisites or exclusions are given.

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