Skip to main content
Glama

Red by Big Red Cloud

Delete Sales Invoice

brc_delete_sales_invoice
Destructive

Deletes or removes an identified BRC sales invoice after explicit confirmation using the invoice's current concurrency timestamp. confirmWrite is the confirmation field; confirmDelete is a legacy compatibility alias. Requires a valid routeToken issued for the matching action workflow. The token remains valid through lookup, preview and the permitted transaction. Placeholder tokens are invalid. A routeToken does not bypass preview or explicit-confirmation requirements. A call without confirmWrite: true returns confirmation_required and a payload preview. confirmWrite: true applies the previewed change after explicit confirmation. Passing preflight is not confirmation.

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": {
      "companyName": "<companyName>",
      "id": "<id>",
      "routeToken": "<routeToken>"
    },
    "name": "brc_delete_sales_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesSales invoice id.
routeTokenYesOpaque routeToken from brc_route_request for this action workflow. Required for transactional tools. Routing permission only — does not replace preview-before-posting or confirmWrite.
companyNameYesCompany context name, for example YOUR-COMPANY-NAME.
confirmWriteNoExplicit confirmation of the previewed invoice deletion.
confirmDeleteNoLegacy alias for confirmWrite; either confirmation flag is sufficient.
connectionRefNoOpaque Red connection reference returned by brc_confirm_company_connection. Pass this exact value on every later tool call when the MCP client rotates session ids (for example Vibe/Mistral). Keep reusing the same connectionRef after successful tool calls — do not start a new connection because a lookup returned empty or partial data. It is not an API key and does not contain credentials.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / confirmDelete / description
      Added value: +"Legacy alias for confirmWrite; either confirmation flag is sufficient."
    • changedInput schema / properties / confirmWrite / description
      Previous value: -"Must be true only after a plain-English preview before posting has been shown in the current conversation and the user explicitly confirmed posting (for example yes, create it / post it now / confirm). Never set true on the first call or because the user initially asked to create something. Nothing is written to Big Red Cloud until you confirm."New value: +"Explicit confirmation of the previewed invoice deletion."
  2. Changed2 schema fields changed
    • addedInput schema / properties / routeToken
      Added value: +{
      +  "description": "Opaque routeToken from brc_route_request for this action workflow. Required for transactional tools. Routing permission only — does not replace preview-before-posting or confirmWrite.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "companyName",
      -  "id"
      -]New value: +[
      +  "companyName",
      +  "id",
      +  "routeToken"
      +]
  3. Changed2 schema fields changed
    • removedInput schema / properties / routeToken
      Removed value: -{
      -  "description": "Opaque routeToken from brc_route_request for this action workflow. Required for transactional tools. Routing permission only — does not replace preview-before-posting or confirmWrite.",
      -  "minLength": 1,
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "companyName",
      -  "id",
      -  "routeToken"
      -]New value: +[
      +  "companyName",
      +  "id"
      +]
  4. Changed2 schema fields changed
    • addedInput schema / properties / routeToken
      Added value: +{
      +  "description": "Opaque routeToken from brc_route_request for this action workflow. Required for transactional tools. Routing permission only — does not replace preview-before-posting or confirmWrite.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "companyName",
      -  "id"
      -]New value: +[
      +  "companyName",
      +  "id",
      +  "routeToken"
      +]
  5. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Beyond the destructiveHint annotation, the description discloses the two-phase confirmation contract, the exact response when unconfirmed (confirmation_required plus a payload preview), that placeholder tokens are rejected, that a routeToken does not bypass preview, and that preflight success is not confirmation. That is exactly the operational detail an agent needs for an irreversible mutation.

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 action and precondition, then the token and confirmation rules in a logical progression. Slightly padded by restating the confirmWrite behavior twice and by an unexplained "Passing preflight is not confirmation" sentence that references a concept the tool never defines.

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 destructive, no-output-schema mutation, the essentials are covered: token provenance, confirmation flow, rejection behavior. It omits whether deletion is reversible or what happens to invoices with downstream allocations, which are the remaining questions an agent would have before calling.

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 the baseline is 3, but the description adds real meaning: it explains confirmWrite as the confirmation field and confirmDelete as a legacy compatibility alias, and frames routeToken as workflow-scoped rather than a bypass. It says nothing extra about connectionRef or companyName beyond the schema.

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 first clause gives a specific verb and resource ("Deletes or removes an identified BRC sales invoice") plus the precondition (explicit confirmation using the invoice's concurrency timestamp). It does not name a sibling tool to differentiate from (e.g. brc_delete_sales_credit_note or brc_batch_sales_invoices), so it lands at a clear-but-undifferentiated 4.

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?

It spells out the prerequisite chain clearly: obtain a routeToken from brc_route_request for the matching workflow, call without confirmWrite to get a payload preview, then call with confirmWrite: true to apply. It stops short of naming when a caller should delete versus void/credit-note instead, so there is no explicit exclusion 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.