Skip to main content
Glama

Void invoice

void_invoice
DestructiveIdempotent

Void an issued invoice (reason required): releases source hours back to Approved and retains the immutable void record. IRREVERSIBLE. Call once with no token to preview; re-call with the returned confirm_token and an idempotency_key to commit.

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": {
      "invoice_id": "<invoice_id>",
      "reason": "<reason>"
    },
    "name": "void_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonYesRequired reason for voiding (recorded in the audit trail).
invoice_idYesId of the issued invoice to void.
confirm_tokenNoToken returned by the preview (call this tool once with no token to get it). Required to commit; expires in ~10 minutes.
idempotency_keyNoRequired when committing (confirm_token present): retrying with the same key returns the original result instead of acting twice.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds materially: the operation is IRREVERSIBLE, it has a side effect on timesheet state (hours return to Approved), an immutable void record is retained, and there is a preview/confirm handshake with a token that expires. These are exactly the consequences an agent needs before committing a destructive call.

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?

Three compact clauses: effect, irreversibility warning, and the two-step invocation protocol. Front-loaded with the action and its side effect, with no filler or repetition of schema text.

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 destructive four-parameter mutation with no output schema, the description covers everything needed: the state change, the irreversibility, the audit record, and the exact preview-then-commit protocol including token expiry and idempotent retry behavior.

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 parameter documentation is already strong and baseline is 3. The description adds workflow-level meaning the schema cannot: the first call omits confirm_token to obtain it, and the second call pairs confirm_token with idempotency_key to commit — clarifying how the four parameters combine across two invocations.

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 ('Void an issued invoice') plus the concrete consequence ('releases source hours back to Approved and retains the immutable void record'). The 'issued' qualifier implicitly separates it from the draft-invoice siblings such as delete_draft_invoice, so an agent can tell which invoice lifecycle state this applies to.

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 explicit call sequencing: 'Call once with no token to preview; re-call with the returned confirm_token and an idempotency_key to commit.' That is a clear when/how. It does not name an alternative path (e.g., credit note instead of void, or draft deletion for unissued invoices), so it stops short of full routing guidance.

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