Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

search_virtual_ips

Read-only

Find and filter pfSense virtual IPs by interface, VIP mode, or keyword, with paginated and sortable results.

Instructions

Search virtual IPs with filtering and pagination

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
sort_byNoField to sort by (subnet, mode, interface, descr, etc.)subnet
interfaceNoFilter by interface (wan, lan, opt1, etc.)
page_sizeNoNumber of results per page
search_termNoGeneral search across subnet/description (client-side filter)
type_filterNoFilter by VIP mode (ipalias, carp, proxyarp, other)

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, establishing the safety profile. The description adds 'filtering and pagination' but does not elaborate on client-side filtering behavior or response structure. No contradiction with annotations, and the additional context is minimal beyond what annotations reveal.

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 that directly communicates the purpose. There is no redundant or extraneous wording—every word earns its place.

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?

With a full input schema, output schema, and read-only annotations, the tool is well-specified. The description is minimal but sufficient; it could optionally clarify the domain of 'virtual IPs' (e.g., CARP VIPs) but the combination of schema and annotations covers most operational context.

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?

The input schema provides descriptions for all 6 parameters (100% coverage), so the baseline is 3. The description's mention of 'filtering and pagination' aligns with the parameters but adds no additional meaning or clarification beyond the schema.

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

Purpose5/5

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

The description clearly states the action ('Search'), the resource ('virtual IPs'), and the capabilities ('filtering and pagination'). It distinguishes from sibling tools like create_virtual_ip, update_virtual_ip, and delete_virtual_ip by focusing on read-only search.

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

Usage Guidelines3/5

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

The description implies use for searching/filtering virtual IPs, but does not explicitly state when to use this tool versus alternatives, nor does it mention any exclusions or prerequisites. Given the sibling context, it's clear this is the search counterpart to CRUD operations, but no direct guidance is provided.

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