opnsense_dns_blocklist_get

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

States 'Read-only' which clarifies safety. No annotations provided, but the description compensates by listing return fields. Lacks explicit mention of side effects (none expected) and authentication requirements, but overall adequate for a simple getter.

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?

Concise one-sentence description that immediately conveys the purpose and key details. No wasted words; front-loaded with action verb 'Get'.

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 no output schema, the description sufficiently describes the return content. It lacks error handling or response format, but for a simple read-only config retrieval, this is acceptable.

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?

No parameters in schema; schema coverage is 100% trivially. Description adds meaning by listing the configuration fields returned (enabled flag, source IDs, custom URLs, NX-domain mode, allowlist), which is essential since there is no output schema.

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?

Clearly states it gets the Unbound DNSBL configuration, enumerating specific fields (enabled flag, source IDs, custom URLs, mode, allowlist). Distinguishes from sibling tools like 'opnsense_dns_blocklist_set' (which sets) and 'opnsense_dns_list_blocklist' (which lists block entries).

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?

Indicates read-only usage, but does not explicitly contrast with siblings or state when not to use. However, the sole purpose of retrieval is clear, and the sibling name 'opnsense_dns_blocklist_set' implies the complementary write operation.

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