openwisp_update_device_connection

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

No annotations are provided, so the description carries the full burden. It discloses PUT/replace semantics and the underlying endpoint, but says nothing about required permissions, whether unspecified fields are cleared, or the response format. For an unannotated mutation tool this is a significant gap.

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 a single tightly scoped sentence plus endpoint, front-loading the category and operation with no wasted words. It is perhaps slightly too terse given the mutation risk, but structurally sound.

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 2-parameter mutation tool with no annotations and no output schema, the description covers the operation and endpoint but omits the behavioral context (replacement side effects, prerequisites) an agent would need. It's adequate but leaves clear 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 in the schema. The description adds no parameter detail beyond that, so the baseline 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?

The description gives a specific verb ('Replace') and resource ('device connection definition'), and the embedded HTTP PUT endpoint reinforces that this is a full-replacement operation. It's clear what the tool does, though it doesn't explicitly distinguish itself from the closest sibling, openwisp_patch_device_connection.

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 word 'Replace' (and the PUT endpoint) implies full-overwrite semantics as opposed to the partial update offered by openwisp_patch_device_connection, but usage is only implied. There is no explicit statement of when to choose this over PATCH or create/get/delete variants.

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