Skip to main content
Glama

Update user

update_user

Update an existing user’s identity or client trust settings. Uses Backend API validation. Null clears nullable string fields; omitted fields stay unchanged. Passwords, credential inputs and metadata are rejected. Returns selected safe user fields. dry_run previews only the approved changes without updating the user.

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": {
      "application_id": "<application_id>",
      "instance": "<instance>",
      "user_id": "<user_id>"
    },
    "name": "update_user"
  }
}

Input Schema

NameRequiredDescriptionDefault
localeNo
dry_runNo
user_idYes
instanceYesInstance to target: "development", "production", or a full instance ID (ins_…).
timezoneNo
usernameNo
last_nameNo
first_nameNo
external_idNo
application_idYesClerk application ID (app_…).
bypass_client_trustNo

Output Schema

NameRequiredDescriptionDefault
idNo
bodyNo
dry_runNo
user_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • removedInput schema / properties / external_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / external_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / first_name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / first_name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / last_name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / last_name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / timezone / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / timezone / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / username / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / username / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), and the description adds substantive context beyond them: null-vs-omitted write semantics, input rejection rules, server-side validation, and a dry-run mode. Remaining gaps are vague phrasing like 'Uses Backend API validation' and no statement of permission or auth requirements, which matters for a non-idempotent write.

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?

Five tightly packed sentences with the core purpose front-loaded and behavioral rules following in logical order. Each sentence carries a distinct rule; only 'Uses Backend API validation' is filler-grade.

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?

An output schema exists, so return detail can be terse, though the description still notes it returns selected safe fields. For an 11-parameter mutation tool the definition covers write semantics, dry-run and input rejection adequately; only auth requirements and the meaning of bypass_client_trust are left unaddressed.

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 only 18%, so the description must carry semantic weight, and it does explain the null/omitted convention that governs the nullable string fields. However, notable parameters such as bypass_client_trust, locale, timezone and dry_run's interaction with the update are not explained at the parameter level.

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+resource ('Update an existing user's identity or client trust settings') and scopes the writable surface to identity and client-trust fields. Saying passwords, credentials and metadata are rejected implicitly separates it from update_user_metadata without naming it, though an explicit pointer would have made the differentiation airtight.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives real operating rules: 'dry_run previews only the approved changes without updating the user', 'Null clears nullable string fields; omitted fields stay unchanged'. The rejection of metadata and credential inputs tells an agent what not to send here, but no alternative tool is named for those cases.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources