Skip to main content
Glama

Update client

update_client

Update an existing client — only include the fields you want to change

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesClient ID (from list_clients)
nameNoClient name
foldersNoFolder IDs (from list_folders)
managerNoManager user ID (from list_users)
websiteNoClient website URL
currencyNoCurrency ISO 4217 code, e.g. "USD" — the server fills in symbol + country iso
theme_idNoTheme ID (use list_themes to find one)
timezoneNoIANA timezone
domain_idNoWhite-label domain ID (from list_domains)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe client as saved. Changing the website re-derives its branding, so the theme_id may come back different.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish that this is a non-read-only, non-destructive mutation. The description adds an important behavioral trait beyond the annotations: it is a PATCH-style update, and unspecified fields remain unchanged. This is genuinely useful for the agent.

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 front-loaded sentence that conveys the core behavior immediately. Every word earns its place; there is no filler or redundant repetition of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter update tool, the schema and output schema already document all parameters and return shape. The description adds the one missing behavioral fact — only changed fields need to be included — making the definition complete enough for an agent to invoke it correctly.

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

Parameters4/5

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

The schema has 100% parameter description coverage with excellent provenance hints (e.g. IDs sourced from list_clients, list_folders, list_users, list_themes, list_domains). The description itself adds only the partial-update semantics, but that is exactly the key cross-cutting parameter behavior the schema cannot convey per-field.

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 specific verb ('Update'), a specific resource ('an existing client'), and the key semantic of partial updates. It clearly distinguishes this from create_client, archive_client, and get_client without requiring the agent to open the schema.

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?

The phrase 'existing client' clearly implies this tool is for modifying already-created clients, and 'only include the fields you want to change' gives a clear usage pattern. It does not explicitly name alternatives or exclusions, but the context is clear enough for correct selection.

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