Skip to main content
Glama
Sign In
truenas-ws-mcp

truenas-ws-mcp

by thoriphes
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

update_user

Modify user account properties on TrueNAS Scale by specifying the user ID and updated attributes.

Instructions

Update user properties.

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>",
      "properties": "<properties>"
    },
    "name": "update_user"
  }
}

Input Schema

NameRequiredDescriptionDefault
user_idYes
propertiesYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

C2.5/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It only states the action but does not mention side effects, permission requirements, idempotency, or what happens to existing properties not specified. This is insufficient for a mutation tool.

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

Conciseness2/5

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

The description is very short (two words) but omits critical information. This is under-specification rather than conciseness. A good description should include usage context and parameter hints.

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 having an output schema (not shown), the description lacks context about behavior, required scopes, or parameter constraints. For a tool with 2 required parameters and complex nested objects, more guidance is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% (no parameter descriptions in schema), and the tool description adds no additional meaning to the parameters. The 'properties' parameter is an object with additionalProperties true, but no hint on valid keys or value types is given.

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 'Update user properties' clearly states the verb (update) and resource (user properties). It distinguishes this tool from sibling tools like create_user, delete_user, get_user, and list_users. However, it could be more specific about which properties can be updated, but the schema provides some clarity.

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 on when to use this tool versus alternatives, such as when to prefer update_user over other user-related tools. There is no mention of prerequisites, context, or exclusions.

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