Skip to main content
Glama

Update identity

identities.update

Update a mock identity: profile fields, isActive (activate/deactivate), emailVerified, and custom claims merged into the ID token and userinfo.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoDisplay name. Optional.
claimsNoCustom claims (e.g. role, plan) merged into the ID token and userinfo. Replaces existing claims. Reserved claim names are rejected. Optional.
isActiveNoWhether the identity can be used in OAuth flows. Optional.
usernameNoIdentity username. Optional.
avatarUrlNoAvatar URL. Optional.
identityIdYesIdentity ID
emailVerifiedNoValue of the email_verified claim issued for this identity. Optional.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesIdentity ID
nameNoDisplay name
clientIdYesOAuth client ID the identity belongs to
usernameNoIdentity username
avatarUrlNoAvatar URL
mailboxAddressYesMailbox address the identity is linked to

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already indicate a mutation (readOnlyHint=false). The description adds useful behavioral context: it specifies which fields can be updated and that custom claims are 'merged into the ID token and userinfo.' This goes beyond the annotations. However, the description does not disclose idempotency or the 'replaces existing claims' semantics (which the schema states), and the word 'merged' could be slightly ambiguous.

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, concise sentence that front-loads the action and resource, then lists the updatable components efficiently. There is no redundant phrasing or unnecessary detail; every word earns its place.

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?

For a tool with 7 parameters and an existing output schema, the description covers the primary update purpose and key behaviors (field updates and claims handling). It lacks explicit usage guidance, but the schema handles parameter details and the output schema covers return values. The description is sufficiently complete for an agent to understand scope without being exhaustive.

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 coverage is 100% and each parameter has a description. The description adds a high-level grouping (profile fields, isActive, emailVerified, custom claims) and clarifies isActive as activate/deactivate, but it does not provide per-parameter detail beyond the schema. Baseline 3 is appropriate when the schema fully documents each parameter.

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 states a clear action ('Update') on a specific resource ('mock identity') and enumerates the key fields (profile fields, isActive, emailVerified, custom claims). It distinguishes from sibling tools like identities.create or identities.delete by its focus on modifying an existing identity. The purpose is unambiguous even without explicit sibling naming.

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 guidance on when to use this tool versus alternatives. It does not mention that this is for existing identities only, nor does it contrast with identities.create or other related operations. The description is purely functional and leaves the agent to infer usage from the tool name and sibling context.

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.

TDQS

A3.6/5.0
Disambiguation5/5

Every tool is scoped to a specific resource and action, and the dot-separated prefixes keep domains, mailboxes, mails, attachments, identities, OAuth clients, and team entities clearly distinct. Even similar actions like archived.delete vs mailboxes.delete or attachments.add vs mails.inject are unambiguous from context.

Naming Consistency5/5

All tools follow the same resource.action pattern with lowercase dot-separated names and consistent plural resource prefixes. Multiword actions like delete_bulk and rotate_secret are consistently snake_cased, so the convention is predictable across all 40 tools.

Tool Count2/5

At 40 tools, the surface is quite large and exceeds the 25+ threshold where tool sets become heavy for an agent to navigate. The grouping is coherent, but this many discrete operations would have been easier to manage with fewer, more consolidated endpoints.

Completeness4/5

The API covers the main lifecycle operations for mailboxes, mails, attachments, archived items, domains, identities, OAuth clients, and team members, with no dead ends in core flows. Minor gaps exist, such as no domains.get, no team.invitations.get, and no mailbox update/expiry operation, but these are workable via list operations.

Resources