openwisp_get_device_connection

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

No annotations are provided, so the description carries the burden. It does disclose the HTTP GET endpoint, which signals a read-only, non-mutating operation and gives a concrete target path. However, it says nothing about required permissions, 404/error behavior, or whether the returned connection includes nested data.

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 compact elements: a category tag and a purpose sentence followed by the endpoint. The purpose is front-loaded and nothing is padded, though the trailing endpoint parenthetical is mostly redundant with the description body.

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 two-required-param getter with full schema coverage, the description is minimally sufficient. With no annotations and no output schema, it could still say whether the connection payload is returned directly or wrapped, and what a missing connection yields, but these are modest gaps.

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% — both device_id and connection_id are documented as UUID-or-ID in the schema. The description adds no format, syntax, or lookup semantics beyond that, so the baseline of 3 applies.

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 ('Get details') and resource ('a specific device connection'), which cleanly separates it from openwisp_list_device_connections and the update/patch/delete connection siblings. It does not explicitly name those siblings, but the singular 'specific' framing makes the retrieval intent unmistakable.

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?

There is no guidance on when to use this versus openwisp_list_device_connections or openwisp_get_device. The only implied usage comes from the required IDs in the schema, which the agent already sees without the description.

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