pve_node_disk_smart

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

With no annotations, the description fully conveys behavioral traits: it explicitly states it is a read-only GET operation and does not trigger a self-test, ensuring the agent understands its non-destructive, safe nature.

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 extremely concise with only two sentences and a path snippet, front-loading the core purpose. Every sentence adds value, no fluff.

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?

Given the tool's simplicity and presence of an output schema, the description covers the essential purpose and behavior. However, it omits details on default node behavior and disk format requirements, leaving minor gaps that could impede usage.

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?

Description provides no additional meaning for 'disk' or 'node' beyond the schema's titles. The disk parameter lacks format guidance (e.g., device path), and node usage is unclear. With only 33% schema description coverage, the description does not compensate, leaving the agent to infer parameter details.

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 it retrieves SMART health data for a disk, specifying the resource (disk) and operation (get health data). It distinguishes from siblings like pve_node_disks_list and pve_node_disk_wipe by focusing on health, and includes the HTTP path for clarity.

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 'Smoke-confirm' line explicitly notes the tool is read-only and does not trigger a self-test, guiding appropriate usage. However, it lacks explicit when-to-use versus alternatives, though no other sibling provides SMART data, making the context clear.

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