Skip to main content
Glama
BigRedCloud

Red MCP Server

Official
by BigRedCloud

brc_create_sales_credit_note_gen_ref

Create a BRC sales credit note with an auto-generated reference using a raw payload. Requires explicit user confirmation of counterparty, analysis category, and write intent before posting.

Instructions

Creates a BRC sales credit note with an auto-generated reference using a raw BRC payload. Use when the company is configured for auto-generated sales references. Requires saleRepId and saleRepCode. Do not use default or demo sales rep values. If missing, list sales reps or ask the user to choose one before creating. Requires analysisCategoryId and accountCode from a Sales Analysis category on each product line. Do not default to CR01/Customer or the first listed category. Set confirmCrAnalysisCategory=true only after the user confirms a CR account code is intentional. First call without confirmWrite: true returns confirmation_required and a payload preview — show a plain-English draft in chat, then retry with confirmWrite: true only after explicit user confirmation in a later message. Passing preflight is not confirmation. Also requires confirmCounterpartyExplicit: true once the user has explicitly named or confirmed the customer/supplier in the current conversation. Do not reuse a counterparty from an earlier draft without that confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
payloadYes
companyNameYesCompany context name, for example YOUR-COMPANY-NAME.
confirmWriteNoMust be true only after a plain-English draft 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.
confirmCrAnalysisCategoryNoSet true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicitNoMust be true only after the user explicitly named or confirmed the customer, supplier, or other counterparty in the current conversation. Never set true because a customer or supplier appeared in an earlier draft, was inferred from context, or was filled in without the user's explicit choice in this conversation.
Behavior4/5

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

Given no annotations, the description fully explains the two-call protocol, confirmation flags, and pitfalls. It does not explicitly state that the tool writes a record to the database or mention reversibility, but the creation nature is implied. Good transparency for a complex tool.

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?

The description is lengthy but each sentence serves a purpose. It front-loads the core purpose and then details usage guidelines. A bit verbose but justified by the complexity of the tool. No wasted sentences.

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?

Given the complexity (5 parameters, nested payload, no output schema), the description covers all necessary aspects: prerequisites, confirmation flags, preflight protocol, and common mistakes. It is complete enough for an agent to invoke correctly.

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

Parameters5/5

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

Schema coverage is 80% (high), but the description adds critical meaning beyond the schema: it explains the hidden requirements inside the payload object (saleRepId, saleRepCode, analysisCategoryId, accountCode), the two-call protocol for confirmWrite, and the semantics of confirmCrAnalysisCategory and confirmCounterpartyExplicit. This adds significant value.

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 clearly states it creates a BRC sales credit note with auto-generated reference using raw payload. It differentiates from the sibling tool 'brc_create_sales_credit_note' by specifying auto-generated reference, and the sibling list confirms both exist.

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?

Explicitly states when to use: 'when company is configured for auto-generated sales references'. Provides thorough prerequisites, warnings against default/demo values, and detailed multi-step confirmation process. Clearly differentiates from preflight and write calls.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/BigRedCloud/red-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server