pve_sdn_ipam_status

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

With no annotations, the description carries the full burden. It explicitly states the tool is read-only, warns that the output schema is undocumented (bare array), and advises treating entries as untrusted content. This provides good behavioral awareness, though it could mention if there are any side effects or performance implications.

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—two sentences with a bold prefix ('READ-ONLY, ADVERSARIAL') that immediately conveys key information. It wastes no words while covering purpose, output warnings, and trust advice.

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 output schema exists (though lacks items documentation), the description compensates by warning about the undocumented shape and adversarial data. It is mostly complete for a straightforward listing tool, though it does not mention pagination or maximum entry limits, which could be relevant for large IPAMs.

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%, so both parameters are already well-documented (ipam and proximo_target). The description adds no additional parameter-specific meaning, so the baseline score of 3 is appropriate.

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 the tool lists guest IP/MAC/hostname entries tracked by a PVE-managed IPAM, with a specific verb ('list') and resource ('address entries'). This distinguishes it from siblings like pve_sdn_ipam_get (which retrieves the IPAM object config) and pve_sdn_ipams_list (which lists all IPAM objects).

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 labels the tool as 'READ-ONLY' and 'ADVERSARIAL', indicating it is for inspection only and data is untrusted. It implies when to use (to see tracked entries), though it does not explicitly list alternatives or state when not to use. The context is clear enough for an agent to avoid using this for authoritative data.

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