Skip to main content
Glama
gensecaihq

pfSense MCP Server

by gensecaihq

update_ipsec_phase2

Idempotent

Modify existing IPsec Phase 2 tunnel settings by ID, including mode, networks, lifetime, and protocol, with immediate application option.

Instructions

Update an existing IPsec Phase 2 (Child SA / tunnel) entry by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoTunnel mode (tunnel, transport, vti)
descrNoDescription
ikeidNoParent Phase 1 IKE ID
lifetimeNoSA lifetime in seconds
protocolNoIPsec protocol (esp, ah)
phase2_idYesPhase 2 entry ID (from search_ipsec_phase2s)
localid_typeNoLocal network type (address, network, lan, none)
remoteid_typeNoRemote network type (address, network, none)
localid_addressNoLocal network address
localid_netbitsNoLocal network prefix length
remoteid_addressNoRemote network address
remoteid_netbitsNoRemote network prefix length
apply_immediatelyNoWhether to apply changes immediately

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=false, idempotentHint=true, and destructiveHint=false. The description accurately reflects a mutation operation ('Update') and adds no contradictory behavior. However, it provides no additional context beyond the annotations, such as whether updating an ID that doesn't exist will error, or whether partial updates are allowed. With annotations present, this is acceptable but not richly transparent.

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 front-loads the verb and resource. Every word adds clarity, with no redundant filler or restatement of the tool name.

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 tool has rich supporting structured data: a 13-parameter schema with 100% description coverage, annotations for idempotency and safety, and an output schema. Given this, the one-sentence description is adequate for an update operation. It could mention that the ID should come from search_ipsec_phase2s, but that is already in the schema's phase2_id description. Minor gap: no mention of the apply_immediately flag's effect, but that's in the schema.

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 13 parameters. The description itself adds little parameter meaning beyond the required phase2_id. It confirms the update target is 'by ID', which aligns with the required parameter. Baseline 3 is appropriate given the schema does the heavy lifting.

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 uses a specific verb ('Update') and identifies the exact resource ('IPsec Phase 2 (Child SA / tunnel) entry') with a key qualifier ('by ID'). This clearly distinguishes it from sibling tools like create_ipsec_phase2, delete_ipsec_phase2, or search_ipsec_phase2s.

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 on existing entries via the word 'existing' and the ID requirement, but it does not explicitly state when to use this tool versus creating a new Phase 2 or deleting one. It also doesn't mention whether changes need to be applied separately (e.g., via apply_ipsec_changes), though the schema's apply_immediately parameter hints at this.

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