Skip to main content
Glama

Update account

update_account

Update a chart-of-accounts ledger account by id — its name, description, group or settings. See list_accounts for ids.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoAccount id to update (see list_accounts).
iconNoIcon identifier for the account (UI display).
metaNoOpaque metadata string stored on the account.
nameNoAccount name (e.g. "Consulting income", "Rent").
roleNoSemantic reporting role: "tax" (income-tax expense), "taxprovision" (tax provision/liability), or "salestax" (VAT control account). Omit for an ordinary account.
groupNoGroup label the account is organised under in the chart of accounts.
hiddenNoWhether the account is hidden from the chart-of-accounts UI.
deletedNoSoft-delete flag; true hides the account from active use.
journalNoJournal number classifying the account; maps to a standard journal name (e.g. sales, purchases, general).
premiumNoWhether the account is a premium-plan-only account.
primaryNoWhether this is the primary account of its kind.
parentidNoId of the parent account this nests under in the chart-of-accounts tree.
defaultidNoNumeric id of the built-in/default account this custom account maps to.
baseaccountNoWhether this is a base/system account rather than a user-created one.
descriptionNoFree-text description of what the account is used for.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changed
    • addedInput schema / properties / baseaccount / description
      Added value: +"Whether this is a base/system account rather than a user-created one."
    • addedInput schema / properties / defaultid / description
      Added value: +"Numeric id of the built-in/default account this custom account maps to."
    • addedInput schema / properties / deleted / description
      Added value: +"Soft-delete flag; true hides the account from active use."
    • addedInput schema / properties / description / description
      Added value: +"Free-text description of what the account is used for."
    • addedInput schema / properties / group / description
      Added value: +"Group label the account is organised under in the chart of accounts."
    • addedInput schema / properties / hidden / description
      Added value: +"Whether the account is hidden from the chart-of-accounts UI."
    • addedInput schema / properties / icon / description
      Added value: +"Icon identifier for the account (UI display)."
    • addedInput schema / properties / id / description
      Added value: +"Account id to update (see list_accounts)."
    • addedInput schema / properties / journal / description
      Added value: +"Journal number classifying the account; maps to a standard journal name (e.g. sales, purchases, general)."
    • addedInput schema / properties / meta / description
      Added value: +"Opaque metadata string stored on the account."
    • addedInput schema / properties / name / description
      Added value: +"Account name (e.g. \"Consulting income\", \"Rent\")."
    • addedInput schema / properties / parentid / description
      Added value: +"Id of the parent account this nests under in the chart-of-accounts tree."
    • addedInput schema / properties / premium / description
      Added value: +"Whether the account is a premium-plan-only account."
    • addedInput schema / properties / primary / description
      Added value: +"Whether this is the primary account of its kind."
    • addedInput schema / properties / role / description
      Added value: +"Semantic reporting role: \"tax\" (income-tax expense), \"taxprovision\" (tax provision/liability), or \"salestax\" (VAT control account). Omit for an ordinary account."
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already indicate readOnlyHint=false, so the mutation nature is known. The description adds 'by id' and the list_accounts reference, but does not disclose potential side effects of setting fields like 'deleted' or 'hidden' which affect visibility. The description could mention soft-delete behavior but is not contradictory.

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 concise and front-loaded: it states the action and resource in the first sentence and provides a practical pointer for ids in the second. No redundant information or filler.

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 an update operation, the description is complete: it names the resource, the identifier, and the common updatable aspects (name, description, group, settings). No output schema exists, so no return spec is needed. The id lookup hint covers the only prerequisite.

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?

The schema provides descriptions for all 15 parameters, covering 100% of them. The tool description adds no extra parameter semantics beyond the schema, so the baseline score of 3 is appropriate.

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 clearly states the action (update), the resource (chart-of-accounts ledger account), and the key identifier (by id). It also differentiates from list_accounts by pointing to it for ids, which helps an agent know this is for modifying existing accounts.

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

Usage Guidelines3/5

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

It provides a useful hint on obtaining ids via list_accounts, but does not explicitly contrast with create_account or delete_account for when to use update vs. alternatives. The description could be more explicit about partial updates (all fields optional) but the schema implies this.

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