Skip to main content
Glama

Reverse a journal entry

well_create_journal_entry_reversal

Reverse ONE posted journal entry: Well writes a new entry dated today with the same lines, debit and credit swapped, so the two cancel out. The posted entry stays as it is: a posted entry is never deleted.

Call it when the person asks to delete, cancel or undo a posted (validated or locked) entry and chose to reverse it, or asks to reverse it. To delete a posted entry, first say it is posted and is not deleted, offer the reversal dated today, and call this tool only on the person's yes. Pass the journal_entry_id.

Only an owner or an admin of the workspace reverses an entry. Refused, with nothing written: a draft entry (it is not posted, so there is nothing to reverse), an entry that already reverses another, an entry a connected accounting tool synced in (reverse it in that tool), and a reversal whose period (today's) is locked. A second call on the same entry returns the reversal the first one wrote.

Returns { success: true, reversal }, the new entry with its number and date. Name both numbers in the reply ("BQ-0211 is reversed by OD-0031 of 15 Oct"). { success: false, error } means nothing was written: say why from error.

Input Schema

NameRequiredDescriptionDefault
workspace_idNoTarget workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
conversation_idNoThe conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
idempotency_keyNoOptional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
workspace_scopeNoRestrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.
journal_entry_idYesThe journal_entry_id of the posted entry to reverse.

Output Schema

NameRequiredDescriptionDefault
codeNo
errorNo
successYes
reversalNo
reply_linesNo
conversation_idNoThe conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
near_candidatesNo
newly_connectedNoTools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
conversation_id_noteNoPresent only when the server opened a fresh lane, stating that no choice recorded earlier was read.
conversation_id_sourceNoWhere the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.
near_candidates_truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / code
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / near_candidates
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "company_id": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "company_id",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / near_candidates_truncated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / reply_lines
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  2. Changed1 schema field changed
    • removedOutput schema / properties / reversal / description
      Removed value: -"The new entry that reverses the posted one."
  3. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only cover readOnly=false, destructive=false, openWorld=false; the description adds the substantive behavior: the original entry is never removed, refusals for draft entries, reversal-of-reversal, connector-synced entries, and locked periods, plus idempotency ('a second call returns the reversal the first one wrote') and the owner/admin permission requirement. It is consistent with destructiveHint=false, since the operation only appends a cancelling entry.

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?

Front-loaded with the reversal mechanism, then trigger, then refusals, then return contract — a logical order with no filler. It is dense and slightly long for a single-action tool, with some prescribing of reply phrasing that could be trimmed, but every paragraph carries operational content.

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 mutating, non-delete accounting operation it covers what is created, what is preserved, who may call it, when it is refused, idempotent retries, and both success and failure return shapes (with the success payload naming the reversal entry). With an output schema and complete annotations present, nothing an agent needs to call this correctly is missing.

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 coverage is 100% and all five parameters are fully documented in the schema, so the baseline is 3. The description only instructs 'Pass the journal_entry_id' and says nothing about workspace_id, workspace_scope, conversation_id or idempotency_key, so it adds almost no semantics beyond the structured fields.

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 and resource — 'Reverse ONE posted journal entry' — and immediately describes the mechanism (new entry dated today, same lines, debit/credit swapped, both cancel out). The uppercase 'ONE' and the 'posted entry is never deleted' clause distinguish it cleanly from well_delete_journal and well_update_journal_entry in the sibling list.

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?

Gives an explicit trigger ('the person asks to delete, cancel or undo a posted entry and chose to reverse it'), an explicit interaction protocol (say it is posted, offer the dated reversal, call only on a yes), and a negative list of situations where the call will be refused. An agent never has to infer whether to invoke this versus deleting or editing a journal.

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