switch_ports

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

readOnlyHint=true already declares the safety profile, so the '[READ]' prefix is largely redundant with structured data. Beyond that, the description says nothing about what configuration data is returned, whether the serial must belong to a switch, or any permissions/rate-limit considerations. The one genuinely new detail is that omitting target yields the default target.

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 purpose is front-loaded in a single sentence followed by a compact Args block; there is no filler. The docstring-style 'Args:' formatting is slightly heavier than a prose sentence would be but not wasteful.

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-parameter read tool this is nearly adequate, but with no output schema the description leaves the return value entirely unexplained and gives no hint about the shape or size of the port configuration payload. It is minimally viable rather than complete.

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 0%, so the description carries the full documentation burden, and it does so for both parameters: serial is qualified as an MS switch serial (narrowing the accepted input), and target is explained as a config name with an explicit default fallback. This is meaningful added semantics, though it doesn't state the format or allowed values of a target name.

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 resource ('Switch (MS) port configuration') and the keying parameter ('by serial'), and the [READ] tag disambiguates the ambiguous verb 'Switch' as a retrieval rather than a mutation. It does not differentiate itself from siblings such as device_uplinks or network_vlans, which an agent might reasonably confuse it with.

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 description supplies no when-to-use context, no prerequisites (e.g. that the device must be an MS switch), and no alternative tool to prefer. The only guidance is the parameter-level note to omit target for the default, which is invocation detail rather than usage guidance.

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