System info (SSH)

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

The description lists the specific data points returned and confirms no modifications. It aligns with the readOnlyHint annotation, and no side effects are implied. The information provided goes beyond the annotation by detailing the contents.

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 sentence that enumerates the key information without excessive detail. It is well-structured and easy to parse.

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?

The description is sufficient for a read-only system information tool. It does not require additional context about return format or error handling, as it is straightforward.

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 no parameters, and the schema coverage is complete. The description does not need to explain parameters, so the baseline score 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 clearly states that the tool provides system information (hostname, uptime, disk, etc.) and is read-only. It is distinct from sibling tools by focusing on system-level details rather than data records or logs.

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 indicates it is read-only, suggesting it is safe to use for diagnostic purposes. However, it does not explicitly state when to prefer this over sibling tools like odoo_sh_status or odoo_sh_logs, leaving some ambiguity.

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