Skip to main content
Glama

Red by Big Red Cloud

Update Sales Credit Note

brc_update_sales_credit_note
Destructive

Updates a sales credit note while preserving the existing BRC unpaid value. 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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSales credit note id.
noteNo
totalNo
detailsNo
procDateNoProcessing date. Historical dates may be attempted; BRC determines whether the update is permitted.
totalNetNo
totalVATNo
entryDateNoEntry date. Historical dates may be attempted; BRC determines whether the update is permitted.
referenceNo
saleRepIdNo
vatTypeIdNo
customerIdNo
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.
confirmWriteNoMust 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.
ourReferenceNo
productTransNoComplete BRC productTrans collection. Preserve existing line ids and accounting/VAT data when modifying an existing credit note.
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.
yourReferenceNo

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only state destructiveHint=true, but the description goes far beyond that: it discloses the confirmation_required response with payload preview, that confirmWrite: true applies the previewed change only after explicit confirmation, that placeholder tokens are invalid, and that routeToken does not bypass preview or confirmation. This is exactly the kind of behavioral context an agent needs to avoid destructive mistakes.

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?

Six dense sentences with no filler. The purpose is front-loaded and every subsequent sentence explains a distinct, safety-relevant aspect of the transactional workflow. The length is proportionate to the complexity of a destructive two-phase commit tool.

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 19-parameter, destructive, two-phase transaction tool, the description covers the essential behavioral surface: token requirements, preview semantics, confirmation requirements, and the confirmation_required response path. It omits success-response shape and other error conditions, but since no output schema exists and the safety-critical flow is thoroughly documented, it is nearly complete.

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 only 42%, so the description should compensate for undocumented data parameters (note, total, details, totalNet, totalVAT, reference, etc.), but it does not. It does add meaningful narrative semantics to the critical transactional parameters (routeToken validity and confirmWrite protocol), which the schema also documents. The low coverage gap for data fields remains unfilled.

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?

The description opens with a specific verb and resource — 'Updates a sales credit note' — and adds a distinguishing constraint: 'while preserving the existing BRC unpaid value.' This clearly differentiates it from creation, deletion, and batch siblings without needing to open any schema.

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?

The description gives strong workflow context: it names the prerequisite (valid routeToken issued for the matching action workflow), explains the two-phase confirmWrite protocol, and states that preflight is not confirmation. It does not explicitly name alternatives (e.g., use brc_create_sales_credit_note to create), but the update-versus-create distinction is clear enough from context.

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.

TDQS

B3.2/5.0
Disambiguation4/5

Most tools have a clear single resource-and-action focus, and the systematic naming helps an agent separate create/get/update/delete/list operations. The main confusion risks are the help/search cluster (red_help, find_help_resources, get_help_resource_details) and the payment/cash-payment/batch-payment variants, which require careful reading of the descriptions to avoid misselection.

Naming Consistency4/5

The brc_ prefix with snake_case verb_noun naming is used consistently across the vast majority of tools, e.g. brc_list_customers, brc_create_sales_invoice, brc_delete_purchase. A few noun-style names like brc_company_readiness_check, brc_grouped_nominal_accounts_report, and brc_red_help break the pattern, but these are minor deviations.

Tool Count1/5

159 tools is an extreme count for an MCP server, well beyond the 50+ threshold described as an extreme mismatch. While the accounting domain is broad, the surface is inflated by batch variants, generated-reference variants, and without-dormant list variants that could be consolidated.

Completeness4/5

Core accounting entities have strong lifecycle coverage: customers, suppliers, products, sales reps, bank accounts, quotes, sales invoices/entries/credit notes, purchases, payments, cash receipts, accruals, prepayments, and nominal journal batches all support relevant CRUD and batch operations. Minor gaps include the quote update being limited to the reference only, no update/create tools for VAT categories or company settings, and email sending being limited to quotes, invoices, and statements.