Skip to main content
Glama

update_user

Idempotent

Modify an existing pfSense local user by ID, including username, password, privileges, certificates, expiration, IPsec PSK, SSH keys, and disabled status.

Instructions

Update an existing pfSense local user by ID

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "user_id": "<user_id>"
    },
    "name": "update_user"
  }
}

Input Schema

NameRequiredDescriptionDefault
certNoList of certificate refids to associate with the user (replaces existing linkage on the user record)
nameNoUsername (login name)
privNoList of privileges to assign (replaces existing)
descrNoUser description / full name
expiresNoAccount expiration date (MM/DD/YYYY format)
user_idYesUser ID (array index from search_users)
disabledNoWhether the user account is disabled
ipsecpskNoIPsec Pre-Shared Key
passwordNoNew password
authorizedkeysNoSSH authorized public keys (base64 encoded)

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.2/5.0
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, so the safety profile is largely covered by structured data. The description adds only that the target must already exist. It does not disclose the crucial patch semantics (whether omitted/null fields are left untouched or cleared) and says nothing about whether a password change invalidates sessions or requires extra privileges.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler or redundancy. It is efficient, though the brevity comes at the cost of any behavioral or routing detail.

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 ten parameters, an output schema, a clear required key, and richer annotations.

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 one of the ten parameters is already documented, including the 'replaces existing' behavior for cert and priv. The description adds no format, validation, or interaction detail beyond the schema, which is the baseline-3 case.

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?

States a specific verb and resource ('Update an existing pfSense local user') plus the addressing key ('by ID'). It implicitly separates itself from create_user and from the FreeRADIUS user tools via 'pfSense local user', but it never names an alternative, so differentiation relies on the reader's inference.

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?

There is no explicit guidance on when to use this versus create_user or update_freeradius_user, and no stated prerequisites such as needing to have found the user_id via search_users. The only usage signal is the implied 'existing ... by ID', which is thin for a tool with 30+ update siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools