Retrieve firewall aliases and their contents, filtered by alias name or description and capped by a limit, to inspect OPNsense alias definitions.
Firewall aliases and their contents.
Args: search: optional text filter on alias name or description. limit: maximum aliases to return (1-1000).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| search | No |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds useful parameter semantics, but it does not describe return format, pagination behavior beyond the limit, or whether alias contents are expanded.
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 short, front-loaded, and wastes little space. The Args block is structured and readable, though the opening sentence is a fragment rather than an explicit action statement.
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?
For a simple read-only list tool with annotations and no output schema, the description covers selection and both parameters adequately. It only lightly describes what 'contents' means and does not explain the returned alias structure, which is a minor 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%, but the description compensates by documenting both parameters: search filters on alias name or description, and limit caps results at 1-1000. It does not restate the default of 200, but the schema carries that.
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 names a specific resource and scope: firewall aliases plus their contents. It lacks an explicit verb such as 'list' and does not distinguish itself from siblings like firewall_rules or firewall_rule_get, but the purpose is clear enough for selection.
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?
It gives no when-to-use guidance, no exclusions, and no routing to alternatives such as firewall_rules. The implied use case is to inspect aliases, but that is left entirely to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.