Skip to main content
Glama

Void document

void_document

Void a document (invoice, quote, credit note, bill or any other kind) by id, or un-void it with void false. A void document keeps its number but leaves the books and the contact's balance. Without confirm true it changes nothing and answers reason confirm-required with what it would do; ask the user, then call again with confirm true. A missing or another business's id is not-found.

Input Schema

NameRequiredDescriptionDefault
idYesContract or legacy invoice id to void or un-void.
voidNotrue (the default) voids the document; false un-voids it.
confirmNoSend true only after the user has agreed to the change the refusal described.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the sparse annotations: it discloses the accounting effect (keeps its number, leaves the books and the contact's balance), the two-step confirmation gate, the exact refusal token (`confirm-required`) and that the refusal describes what would have happened, plus not-found behavior for missing or foreign ids. This is exactly the disclosure an agent needs before mutating financial records.

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 operation and inverse, then the side effect, then the confirm protocol, then the error case — a sensible ordering. It is dense but every clause carries information; the slightly telegraphic phrasing costs a little readability.

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?

No output schema exists, yet the description covers the meaningful return states (confirm-required refusal with a description of the pending change, not-found) and the side effects of the mutation. Nothing critical is missing for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description adds real meaning the schema lacks: the consequence of `void false` (un-void), the exact protocol for `confirm` including the refusal code, and that a foreign id yields not-found. That is value beyond the field descriptions.

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 (void/un-void) on a specific resource (document) and enumerates the document kinds covered (invoice, quote, credit note, bill). It also immediately clarifies the inverse operation via `void false`, so an agent knows the full scope of the tool from one sentence.

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

Usage Guidelines4/5

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

Gives a clear procedural rule: without `confirm true` nothing changes, ask the user, then call again with `confirm true`. It also implies the void-vs-delete distinction by saying a voided document 'keeps its number' while leaving the books. It stops short of naming `delete_document` as the explicit alternative, so routing between the two must be inferred.

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