Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

search_firewall_rules

Read-only

Search firewall rules by interface, type, source IP, destination port, and description. Includes pagination and sorting to locate specific rules quickly.

Instructions

Search firewall rules with advanced filtering and pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
sort_byNoField to sort by (tracker, interface, type, descr, etc.)tracker
disabledNoFilter by enabled/disabled state (true = disabled rules only)
interfaceNoFilter by interface (wan, lan, etc.)
page_sizeNoNumber of results per page (max 200)
rule_typeNoFilter by rule type (pass, block, reject)
source_ipNoFilter by source IP (supports partial matching)
destination_portNoFilter by destination port
search_descriptionNoSearch in rule descriptions

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds no extra behavioral context (e.g., performance, rate limits, or return format), but does not contradict annotations. The mention of pagination is somewhat redundant given the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that front-loads the primary action ('Search firewall rules') and briefly mentions key features. There is no redundancy or wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The schema is rich with 9 well-described parameters, and an output schema exists, so the description needn't explain return values. Annotations cover safety. The description is minimal but adequate for a straightforward search tool, though it could benefit from usage guidance (already penalized in that dimension).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all nine parameters with descriptions. The tool description adds no additional meaning beyond the schema, so a baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's function with a specific verb ('Search') and resource ('firewall rules'), and mentions 'advanced filtering and pagination.' While it doesn't explicitly distinguish from sibling tools like get_pf_rules or find_blocked_rules, the name and description convey a focused search capability.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like get_pf_rules, find_blocked_rules, or search_firewall_schedules. It does not state any exclusions or specific use cases, leaving the agent to infer from the name and schema.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/gensecaihq/pfsense-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server