sys_version

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

With no annotations, the description carries the burden, and it does disclose the key behavioral trait: read-only. It also enumerates the exact data returned (model, firmware, IP, build date). It does not mention output format or whether any side effects occur, but for a read-only info tool this is adequate.

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?

A single compact sentence that front-loads the resource and lists the key fields, with the read-only qualifier included. No wasted words.

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 read-only query, the description is nearly complete: it names the tool's purpose and the data fields. It could be slightly stronger by naming a sibling to disambiguate, but nothing essential is missing for an agent to invoke it correctly.

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 has zero parameters, so there is no parameter semantics burden. The description's field list (model, firmware, IP, build date) effectively tells the agent what the output will contain, which is useful context beyond the empty schema.

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 states a specific verb and resource: it reports router model, firmware version, IP, and build date, and explicitly labels it read-only. This is clear enough to distinguish it from most siblings, though it doesn't name a specific alternative.

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 read-only label implies it is for querying system information rather than changing it, and the listed fields suggest when to use it (e.g., checking firmware or IP). However, it does not explicitly state when to prefer this over similar status tools like sys_info, show_status, or linux_status.

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