Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

search_aliases

Read-only

Search and filter pfSense firewall aliases by type, name, or IP address to locate specific entries quickly.

Instructions

Search aliases with advanced filtering options

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
sort_byNoField to sort byname
page_sizeNoNumber of results per page
alias_typeNoFilter by alias type (host, network, port, url)
search_termNoSearch in alias names or descriptions
containing_ipNoFind aliases containing this IP address

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, and the description's 'Search' action is consistent with that. However, the description adds no additional behavioral context such as whether results are paginated (already in schema) or if any special permissions are needed. It's adequate but not enriching.

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, front-loaded sentence: 'Search aliases with advanced filtering options.' No filler or redundancy. It earns its place by stating the core function, though it's minimal.

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?

Given the rich schema (100% coverage) and presence of an output schema, the description doesn't need to detail return values or parameters. It sufficiently identifies the tool's purpose. However, it lacks any contextual notes about scope or edge cases, so it's slightly incomplete compared to the get_calls example, but still adequate.

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 fully documents all six parameters (page, sort_by, page_size, alias_type, search_term, containing_ip). The description's 'advanced filtering options' vaguely references these but adds no detail beyond the schema. 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 uses the specific verb 'Search' and resource 'aliases', clearly identifying the tool's operation. It's distinct from sibling CRUD tools (create_alias, update_alias, delete_alias) and other search tools by resource type. However, it doesn't elaborate on what 'advanced filtering options' entails, making it slightly generic.

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?

No guidance on when to use this tool vs alternatives. It doesn't mention that this is the appropriate tool for finding aliases by various criteria, nor does it exclude cases like searching within alias addresses (manage_alias_addresses). Lacks explicit when/when-not instructions.

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