Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

search_users

Read-only

Search pfSense local users by name or description. Supports pagination and sorting to retrieve specific user accounts from the firewall.

Instructions

Search pfSense local users with optional filtering and pagination

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
sort_byNoField to sort by (name, descr, disabled, expires, etc.)name
page_sizeNoNumber of results per page
search_termNoSearch term to filter users by name or description

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, so the read-only nature is covered. The description adds 'optional filtering and pagination,' but this largely mirrors the schema parameter descriptions and does not provide additional behavioral context such as result limits or search wildcard behavior.

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 main purpose ('Search pfSense local users') and efficiently mentions the key features (optional filtering and pagination). Every word adds value, with no waste.

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 output schema and complete parameter documentation, the description is sufficient for this simple read-only search tool. It clearly identifies the resource scope and optional filtering/pagination. It could be slightly more explicit about being read-only or directing to user management tools, but annotations cover the safety profile.

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 every parameter (page, sort_by, page_size, search_term) is already documented. The description adds no new parameter semantics beyond what the schema already provides, so a baseline score of 3 is appropriate.

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 'Search pfSense local users' with a specific verb and resource, and mentions optional filtering and pagination. It distinguishes itself from sibling tools like search_groups and search_auth_servers by targeting local users specifically.

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 usage for finding/listing local users with filtering, but does not explicitly state when to use it over alternatives or when not to use it. No exclusions or alternative tool references are provided, so guidance is only implied.

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