opnsense_dns_blocklist_sources_list

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

No annotations are provided, so the description carries the full burden. It declares 'Read-only', which informs the agent that no changes occur. It also specifies what information is returned (internal IDs and selected state). However, it does not disclose potential authentication requirements or any other behavioral traits, but given the simplicity, this is sufficient.

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 is front-loaded with the key action 'List all available built-in DNSBL block-list sources' and includes essential details concisely. Every part of the sentence adds value, with no redundancy.

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 no parameters, no output schema, and is a simple read-only list operation, the description provides sufficient information. It explains what is returned (internal IDs and selected state) and marks it as read-only. No further details are necessary for an agent to use it effectively.

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 input schema has 0 parameters with 100% coverage, so no parameter clarification is needed. The description adds no parameter information, which is appropriate. Baseline for 0 parameters is 4.

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 all available built-in DNSBL block-list sources, including examples like AdGuard, EasyList, etc., and mentions it returns internal IDs and selected state. The name 'sources_list' distinguishes it from sibling tools like opnsense_dns_blocklist_get which retrieves one source or opnsense_dns_list_blocklist which likely lists blocked domains.

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 implies usage for viewing available sources, but does not explicitly state when to use or when not to use, nor does it mention alternatives. It provides examples of sources, which helps contextualize, but lacks explicit guidance.

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