opn_list_dnsmasq_leases

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

With no annotations, the description carries the full burden. It discloses that it lists both DHCPv4 and DHCPv6, and that IPv6 leases appear alongside IPv4. It also describes the return format (dict with 'rows' and 'rowCount'). However, it lacks details on permissions, rate limits, or any side effects. Overall adequate for a read-only list tool.

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 six sentences, front-loaded with the main purpose. Each sentence adds value (purpose, usage context, IPv6 handling, output format). It is concise but could be improved by including parameter descriptions.

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 has two optional parameters with no descriptions and no annotations, the description is incomplete. It adequately describes the output but fails to explain input parameters. For a simple list tool, it is partially complete but has a significant gap.

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% for both parameters ('search' and 'limit'). The description provides no explanation of these parameters or their expected values, leaving the agent to rely solely on the schema defaults, which is insufficient.

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 verb 'list' and the resource 'DHCPv4 and DHCPv6 leases from the dnsmasq DNS/DHCP server'. It distinguishes from sibling tools like opn_list_kea_leases by specifying dnsmasq and referencing opn_scan_config to check the backend.

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 tells when to use this tool ('when the OPNsense instance uses dnsmasq for DHCP') and advises to check the backend first via opn_scan_config. It implies alternatives (kea), though it doesn't explicitly list when not to use.

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