Skip to main content
Glama

stub

by africa.stub.api
OverviewDiscussionsAdmin

Update document item

update_document_item

Change a line that is ALREADY on a document (invoice, quote, bill and so on), not its header: header fields (contact, dates, type) go through save_document, and a new line goes through add_document_line. To change several lines on one document, prefer update_document_items_bulk — one call instead of many.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoLine item id. Required on update_document_item; omit on add_document_line.
costNoUnit cost (for margin / cost-of-sales), in :costcurrency.
nameNoLine item name / title.
sortNoDisplay order of the line within the document (ascending).
unitNoUnit label for the quantity (e.g. "hours", "kg").
priceNoUnit price (per-unit selling price) in the document currency.
amountNoLine total (unit price × quantity), usually derived from :price × :quantity. Accepts a number or a numeric string.
expenseNoPass "$delete" to unlink the expense this line recovers; the line keeps its name, account and amount. Rebilling is add-only, so any other value is refused.
productNoId of a catalog product to link this line to.
variantNoId of a catalog product variant to link this line to.
quantityNoNumber of units. Accepts a number or a numeric string.
accountidNoPer-line chart-of-accounts / expense-category id; bills split cost by category at accrual (see list_accounts).
quinvoiceNoId of the parent document (invoice, quote, bill, etc.) this line belongs to.
responseidNoInternal: correlation id used to return the updated entity to the frontend; omit.
descriptionNoLine item description.
costcurrencyNoISO 4217 currency of :cost, when it differs from the document currency.
baseupdatedatNoOptimistic-concurrency token: the line's last-known updatedat (epoch number or ISO string). A stale value is rejected; omit to skip the check.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / expense
      Added value: +{
+  "description": "Pass \"$delete\" to unlink the expense this line recovers; the line keeps its name, account and amount. Rebilling is add-only, so any other value is refused.",
+  "type": "string"
+}
  2. Changed16 schema fields changed
    • addedInput schema / properties / accountid / description
      Added value: +"Per-line chart-of-accounts / expense-category id; bills split cost by category at accrual (see list_accounts)."
    • addedInput schema / properties / amount / description
      Added value: +"Line total (unit price × quantity), usually derived from :price × :quantity. Accepts a number or a numeric string."
    • addedInput schema / properties / baseupdatedat / description
      Added value: +"Optimistic-concurrency token: the line's last-known updatedat (epoch number or ISO string). A stale value is rejected; omit to skip the check."
    • addedInput schema / properties / cost / description
      Added value: +"Unit cost (for margin / cost-of-sales), in :costcurrency."
    • addedInput schema / properties / costcurrency / description
      Added value: +"ISO 4217 currency of :cost, when it differs from the document currency."
    • addedInput schema / properties / description / description
      Added value: +"Line item description."
    • addedInput schema / properties / id / description
      Added value: +"Line item id. Required on update_document_item; omit on add_document_line."
    • addedInput schema / properties / name / description
      Added value: +"Line item name / title."
    • addedInput schema / properties / price / description
      Added value: +"Unit price (per-unit selling price) in the document currency."
    • addedInput schema / properties / product / description
      Added value: +"Id of a catalog product to link this line to."
    • addedInput schema / properties / quantity / description
      Added value: +"Number of units. Accepts a number or a numeric string."
    • addedInput schema / properties / quinvoice / description
      Added value: +"Id of the parent document (invoice, quote, bill, etc.) this line belongs to."
    • addedInput schema / properties / responseid / description
      Added value: +"Internal: correlation id used to return the updated entity to the frontend; omit."
    • addedInput schema / properties / sort / description
      Added value: +"Display order of the line within the document (ascending)."
    • addedInput schema / properties / unit / description
      Added value: +"Unit label for the quantity (e.g. \"hours\", \"kg\")."
    • addedInput schema / properties / variant / description
      Added value: +"Id of a catalog product variant to link this line to."
  3. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations declare readOnlyHint=false and destructiveHint=false, so the mutation/safety profile is already covered, and the description is consistent with them. The description adds scope context (existing line vs. header) but says nothing about partial-update semantics, permission/auth requirements, or error behavior on stale data. With annotations carrying the safety profile, a 3 is appropriate.

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?

Front-loads the core operation, then the two exclusions, then the bulk alternative — all in two tight sentences with no filler. Every clause 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 17-parameter mutation tool with full schema documentation and no output schema, the description's job is mainly disambiguation, which it does thoroughly. It stops short of describing mutation semantics (e.g. what happens to unspecified fields, concurrency rejection), a minor gap given the schema covers the parameters themselves.

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 all 17 parameters are already fully documented in the schema (including optimistic-concurrency via baseupdatedat and the $delete semantics for expense). The description adds no parameter-level detail beyond that, so the baseline of 3 applies.

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?

States a specific verb (change/update) and resource (a line already on a document), and explicitly scopes it against siblings: header fields go through save_document, new lines through add_document_line. An agent can distinguish this tool from its nearest siblings without opening any 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?

Explicitly covers when to use this tool (changing an existing line), when not to (header edits, adding new lines), and names the preferred alternative for multi-line edits (update_document_items_bulk). The routing logic is complete and leaves nothing to inference.

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