Skip to main content
Glama
Xero MCP Server

Xero MCP Server

Official
by XeroAPI

update-manual-journal

Update a draft manual journal in Xero by changing only the specified fields and lines while leaving all unspecified journal data untouched.

Instructions

Update a manual journal in Xero. Only works on draft manual journals. Do not modify line items or parameters that have not been specified by the user.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "narration": "<narration>",
      "manualJournalID": "<manualJournalID>",
      "manualJournalLines": "<manualJournalLines>"
    },
    "name": "update-manual-journal"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoOptional URL link to a source document
dateNoOptional date in YYYY-MM-DD format
statusNoOptional status of the manual journal (DRAFT, POSTED, DELETED, VOIDED, ARCHIVED), DRAFT by default
narrationYesDescription of manual journal being posted
lineAmountTypesNoOptional line amount types (EXCLUSIVE, INCLUSIVE, NO_TAX), NO_TAX by default
manualJournalIDYesID of the manual journal to update
manualJournalLinesYesThe manualJournalLines element must contain at least two individual manualJournalLine sub-elements
showOnCashBasisReportsNoOptional boolean to show on cash basis reports, default is true

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.0.18
    • changedInput schema / properties / status / description
      Previous value: -"Optional status of the manual journal (DRAFT, POSTED, DELETED, VOID, ARCHIVED), DRAFT by default"New value: +"Optional status of the manual journal (DRAFT, POSTED, DELETED, VOIDED, ARCHIVED), DRAFT by default"
    • changedInput schema / properties / status / enum
      Previous value: -[
      -  "DRAFT",
      -  "POSTED",
      -  "DELETED",
      -  "VOID",
      -  "ARCHIVED"
      -]New value: +[
      +  "DRAFT",
      +  "POSTED",
      +  "DELETED",
      +  "VOIDED",
      +  "ARCHIVED"
      +]
  2. Addedv1.0.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose one critical constraint: only draft journals can be updated. It does not say what happens on a non-draft journal (error vs. silent no-op), whether the call requires specific scopes, or what the response contains — meaningful gaps for a mutation tool with zero annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the action and the binding constraint, with no filler. The final caution sentence is slightly ambiguous about how it interacts with the required manualJournalLines parameter, and a stray double space is a minor polish issue.

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

Completeness3/5

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

For an eight-parameter mutation tool with no annotations and no output schema, the description covers the essential mutability restriction but leaves out error behavior, permission requirements, and any sense of what a successful update returns. It is adequate but not complete for the tool's complexity.

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 eight parameters, including the nested line fields and enums, are already documented in the schema, establishing a baseline of 3. The instruction not to modify unspecified line items or parameters adds some partial-update semantics that the schema does not convey, but it remains ambiguous against the required manualJournalLines array.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource ("Update a manual journal in Xero") and adds a genuine scope qualifier ("Only works on draft manual journals") that separates it from create-manual-journal. It does not explicitly name the sibling alternatives, so it falls short of a 5.

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?

The draft-only precondition gives real when-to-use guidance, telling the agent this call will fail on posted or voided journals. However, it never states what to do instead (e.g., use create-manual-journal for new journals, or list-manual-journals to find an ID) and offers no guidance on prerequisites or the partial-update case.

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