Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

update_alias

Idempotent

Change an existing pfSense alias by its ID—edit its name, type, addresses, or description, and apply the update immediately.

Instructions

Update an existing alias by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew alias name
detailsNoNew per-entry descriptions
alias_idYesAlias ID (array index from search_aliases)
addressesNoNew list of addresses
alias_typeNoNew alias type (host, network, port)
descriptionNoNew description
apply_immediatelyNoWhether to apply changes immediately

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

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

The description only restates the operation without adding behavioral context beyond the annotations. It does not disclose update semantics, such as partial vs. full replacement, behavior with null fields, or the effect of apply_immediately. Given annotations already cover readOnlyHint=false, idempotentHint=true, and destructiveHint=false, the description adds no additional transparency.

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, compact sentence that is entirely front-loaded with the key information. It contains zero redundant or unnecessary words.

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

Completeness2/5

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

Despite high schema coverage and annotations, the description omits critical operational semantics for an update tool, such as how null parameters are handled, whether the update is partial or wholesale, and the implications of apply_immediately. More context is needed for correct invocation, making the description incomplete for this complexity.

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%, with all seven parameters individually described. The description itself adds no parameter-specific meaning beyond mentioning 'by ID', which reinforces alias_id but doesn't go beyond the schema's existing explanation.

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 a specific verb ('Update'), resource ('alias'), and identifier ('by ID'), which distinguishes it from create_alias and delete_alias. However, it does not explicitly differentiate from manage_alias_addresses, which could also be used to modify alias fields, so it's clear but not fully differentiated from all siblings.

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 is provided about when to use this tool versus alternatives like create_alias, delete_alias, or manage_alias_addresses. There are no prerequisites, conditions, or exclusions mentioned, so the description offers no decision support.

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