Skip to main content
Glama
Sign In

stub

by africa.stub.api
OverviewDiscussionsAdmin

Update account

update_account

Update a chart-of-accounts LEDGER account by id, not a bank account; for a bank account, use update_bank_account. Changes its name, description, group or settings. See list_accounts for ids.

Input Schema

NameRequiredDescriptionDefault
idNoAccount id to update (see list_accounts).
codeNoThe business's own account code (e.g. "4000"). Trimmed; an empty string clears it; omit to leave it unchanged.
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.
defaultidNoBuilt-in account id this custom account maps to: a number such as "410" or a string such as "za-coida" or "defaultvat".
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. Changed1 schema field changed
    • changedInput schema / properties / defaultid / description
      Previous value: -"Numeric id of the built-in/default account this custom account maps to."New value: +"Built-in account id this custom account maps to: a number such as \"410\" or a string such as \"za-coida\" or \"defaultvat\"."
  2. Changed1 schema field changed
    • addedInput schema / properties / code
      Added value: +{
+  "description": "The business's own account code (e.g. \"4000\"). Trimmed; an empty string clears it; omit to leave it unchanged.",
+  "type": "string"
+}
  3. 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."
  4. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the safety profile is known. The description adds useful scope (ledger account, not bank account) but does not explain partial-update behavior, permissions, or what happens to omitted fields, so it adds only moderate behavioral context beyond annotations.

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 three short, front-loaded clauses with no wasted text. The primary purpose and the bank-account distinction come first, followed by scope and id source.

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 16-parameter update tool with 100% schema coverage and no output schema, the description supplies the key routing and id-discovery context. It is somewhat sparse on cross-parameter update semantics, such as whether omitted fields remain unchanged, but the annotations and schema cover most remaining needs.

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 100%, so the schema already defines all 16 parameters in detail. The description mentions only a few updatable fields and points to list_accounts for ids, adding little beyond what the schema already provides; baseline 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 states a specific verb and resource: update a chart-of-accounts LEDGER account by id. It explicitly distinguishes this from a bank account and points to update_bank_account for that sibling, so an agent can identify the correct tool without opening 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 Guidelines5/5

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

It gives explicit when-not guidance ("not a bank account; for a bank account, use update_bank_account") and tells the agent where to obtain ids via list_accounts. This is clear routing guidance against a relevant sibling.

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

All stub toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources