Skip to main content
Glama

Red by Big Red Cloud

Batch Quotes

brc_batch_quotes
Destructive

Processes a batch of quotes using either verified flat creator fields or a complete nested BRC Quote payload. Maximum 100 items per batch request. 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. Requires confirmCounterpartyExplicit: true; confirmation is scoped to the counterparty selected for the current preview.

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>",
      "items": "<items>",
      "routeToken": "<routeToken>"
    },
    "name": "brc_batch_quotes"
  }
}

Input Schema

NameRequiredDescriptionDefault
itemsYesBatch items to process. Maximum 100 items per request.
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.
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.
confirmCrAnalysisCategoryNoApplies to every sales document item in this batch. Set true only after the user confirms a CR (customer) sales analysis account code is intentional for these product lines.
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 preview, was inferred from context, or was filled in without the user's explicit choice in this conversation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / items / description
      Previous value: -"Batch items to process. Maximum 20 items per request."New value: +"Batch items to process. Maximum 100 items per request."
    • changedInput schema / properties / items / maxItems
      Previous value: -20New value: +100
  2. Changed5 schema fields changed
    • changedInput schema / properties / items / items / additionalProperties
      Previous value: -{}New value: +false
    • addedInput schema / properties / items / items / properties
      Added value: +{
      +  "item": {
      +    "oneOf": [
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "acCode": {
      +            "description": "Customer account code.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "accountCode": {
      +            "description": "Sales analysis account code.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "analysisCategoryId": {
      +            "description": "Sales analysis category id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "comments": {
      +            "description": "Quote comments.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "companyId": {
      +            "description": "BRC company id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "customerOwnerId": {
      +            "description": "BRC customer owner id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "customerOwnerName": {
      +            "description": "Customer name.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "ddNumber": {
      +            "type": "string"
      +          },
      +          "deliveryTo": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              }
      +            ]
      +          },
      +          "entryDate": {
      +            "description": "Entry date in ISO format.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "layoutType": {
      +            "description": "Quote layout type id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "poNumber": {
      +            "type": "string"
      +          },
      +          "procDate": {
      +            "description": "Processing date in ISO format.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "productCode": {
      +            "description": "BRC product code.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "productId": {
      +            "description": "BRC product id; placeholder ids 0 and 1 are prohibited.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "quantity": {
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          "reference": {
      +            "description": "Optional manual quote reference, maximum six characters.",
      +            "maxLength": 6,
      +            "type": "string"
      +          },
      +          "saleRepCode": {
      +            "description": "BRC sales representative code.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "saleRepId": {
      +            "description": "BRC sales representative id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "tranNote": {
      +            "description": "Quote product-line note.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "unitPrice": {
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          "vatPercentage": {
      +            "type": "number"
      +          },
      +          "vatRateId": {
      +            "description": "BRC VAT rate id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "vatTypeId": {
      +            "description": "BRC VAT type id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "companyId",
      +          "customerOwnerId",
      +          "acCode",
      +          "customerOwnerName",
      +          "comments",
      +          "entryDate",
      +          "procDate",
      +          "saleRepId",
      +          "saleRepCode",
      +          "productId",
      +          "productCode",
      +          "quantity",
      +          "unitPrice",
      +          "vatRateId",
      +          "vatPercentage",
      +          "tranNote",
      +          "analysisCategoryId",
      +          "accountCode"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "acCode": {
      +            "description": "Customer account code.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "closedDate": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "comments": {
      +            "description": "Quote comments.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "companyId": {
      +            "description": "BRC company id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "customFields": {
      +            "items": {},
      +            "type": "array"
      +          },
      +          "customerOwnerId": {
      +            "description": "BRC customer owner id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "customerOwnerName": {
      +            "description": "Customer name.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "ddNumber": {
      +            "type": "string"
      +          },
      +          "deliveryList": {
      +            "type": "string"
      +          },
      +          "deliveryTo": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "entryDate": {
      +            "description": "Entry date in ISO format.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "layoutType": {
      +            "description": "Quote layout type id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "note": {
      +            "type": "string"
      +          },
      +          "poNumber": {
      +            "type": "string"
      +          },
      +          "procDate": {
      +            "description": "Processing date in ISO format.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "productTrans": {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "acEntries": {
      +                  "items": {
      +                    "additionalProperties": false,
      +                    "properties": {
      +                      "accountCode": {
      +                        "description": "Sales analysis account code.",
      +                        "minLength": 1,
      +                        "type": "string"
      +                      },
      +                      "analysisCategoryId": {
      +                        "description": "Sales analysis category id.",
      +                        "exclusiveMinimum": 0,
      +                        "maximum": 9007199254740991,
      +                        "type": "integer"
      +                      },
      +                      "companyId": {
      +                        "description": "BRC company id.",
      +                        "exclusiveMinimum": 0,
      +                        "maximum": 9007199254740991,
      +                        "type": "integer"
      +                      },
      +                      "id": {
      +                        "maximum": 9007199254740991,
      +                        "minimum": 0,
      +                        "type": "integer"
      +                      },
      +                      "quoteProductTranId": {
      +                        "maximum": 9007199254740991,
      +                        "minimum": 0,
      +                        "type": "integer"
      +                      },
      +                      "value": {
      +                        "exclusiveMinimum": 0,
      +                        "type": "number"
      +                      }
      +                    },
      +                    "required": [
      +                      "companyId",
      +                      "accountCode",
      +                      "analysisCategoryId",
      +                      "value"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "amount": {
      +                  "exclusiveMinimum": 0,
      +                  "type": "number"
      +                },
      +                "companyId": {
      +                  "description": "BRC company id.",
      +                  "exclusiveMinimum": 0,
      +                  "maximum": 9007199254740991,
      +                  "type": "integer"
      +                },
      +                "id": {
      +                  "maximum": 9007199254740991,
      +                  "minimum": 0,
      +                  "type": "integer"
      +                },
      +                "percentage": {
      +                  "type": "number"
      +                },
      +                "productCode": {
      +                  "description": "BRC product code.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "productId": {
      +                  "description": "BRC product id; placeholder ids 0 and 1 are prohibited.",
      +                  "exclusiveMinimum": 0,
      +                  "maximum": 9007199254740991,
      +                  "type": "integer"
      +                },
      +                "quantity": {
      +                  "exclusiveMinimum": 0,
      +                  "type": "number"
      +                },
      +                "tranNotes": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "unitPrice": {
      +                  "exclusiveMinimum": 0,
      +                  "type": "number"
      +                },
      +                "vatAmount": {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                "vatAnalysisTypeId": {
      +                  "maximum": 9007199254740991,
      +                  "minimum": -9007199254740991,
      +                  "type": "integer"
      +                },
      +                "vatRateId": {
      +                  "description": "BRC VAT rate id.",
      +                  "exclusiveMinimum": 0,
      +                  "maximum": 9007199254740991,
      +                  "type": "integer"
      +                }
      +              },
      +              "required": [
      +                "companyId",
      +                "percentage",
      +                "vatRateId",
      +                "productId",
      +                "productCode",
      +                "quantity",
      +                "unitPrice",
      +                "amount",
      +                "vatAmount",
      +                "tranNotes",
      +                "acEntries",
      +                "vatAnalysisTypeId"
      +              ],
      +              "type": "object"
      +            },
      +            "minItems": 1,
      +            "type": "array"
      +          },
      +          "reference": {
      +            "description": "Optional manual quote reference, maximum six characters.",
      +            "maxLength": 6,
      +            "type": "string"
      +          },
      +          "saleInvoiceId": {
      +            "anyOf": [
      +              {
      +                "exclusiveMinimum": 0,
      +                "maximum": 9007199254740991,
      +                "type": "integer"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "saleRepCode": {
      +            "description": "BRC sales representative code.",
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "saleRepId": {
      +            "description": "BRC sales representative id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "total": {
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          "totalNet": {
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          "totalVat": {
      +            "minimum": 0,
      +            "type": "number"
      +          },
      +          "vatTypeId": {
      +            "description": "BRC VAT type id.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "companyId",
      +          "customerOwnerId",
      +          "vatTypeId",
      +          "saleRepId",
      +          "saleRepCode",
      +          "entryDate",
      +          "procDate",
      +          "customerOwnerName",
      +          "comments",
      +          "layoutType",
      +          "total",
      +          "totalVat",
      +          "totalNet",
      +          "note",
      +          "acCode",
      +          "productTrans",
      +          "customFields"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  },
      +  "opCode": {
      +    "const": 1,
      +    "description": "BRC batch create operation code. Must be 1.",
      +    "type": "number"
      +  }
      +}
    • removedInput schema / properties / items / items / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • addedInput schema / properties / items / items / required
      Added value: +[
      +  "opCode",
      +  "item"
      +]
    • removedInput schema / properties / priceBasis
      Removed value: -{
      -  "description": "Applies to every sales invoice/credit note item in this batch. Required when Gross Price Entry is enabled. Use `gross` when unit prices are VAT-inclusive/gross. Use `net` when unit prices are VAT-exclusive/net.",
      -  "enum": [
      -    "net",
      -    "gross"
      -  ],
      -  "type": "string"
      -}
  3. 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",
      -  "items"
      -]New value: +[
      +  "companyName",
      +  "items",
      +  "routeToken"
      +]
  4. 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",
      -  "items",
      -  "routeToken"
      -]New value: +[
      +  "companyName",
      +  "items"
      +]
  5. 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",
      -  "items"
      -]New value: +[
      +  "companyName",
      +  "items",
      +  "routeToken"
      +]
  6. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond the annotations' destructiveHint=true / readOnlyHint=false: it explains that a call without confirmWrite:true returns confirmation_required plus a payload preview, that preflight is not confirmation, that placeholder and stale routeTokens are invalid, and that confirmCounterpartyExplicit must be scoped to the counterparty in the current preview. These are the exact failure modes an agent needs to avoid on a destructive 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?

Purpose, item cap and token requirement are front-loaded, and each sentence is short and actionable. There is mild redundancy around the preview/confirmation rule ('does not bypass preview', 'preflight is not confirmation') that could be tightened.

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 batch mutation with 7 parameters and no output schema, the description covers the workflow preconditions, the item limit, and the confirmation_required/preview response shape, which compensates for the missing output schema. It leaves minor gaps, such as the meaning of opCode (const 1) and the precise definition of 'verified flat creator fields'.

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 description coverage is 100%, so confirmWrite, routeToken, confirmCounterpartyExplicit and items are already documented in the schema with nearly identical wording; the description largely restates them. It adds little syntax or format detail beyond the structured fields, so the baseline of 3 applies.

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?

States a specific verb and resource — 'Processes a batch of quotes' — and names the two accepted payload shapes (verified flat creator fields or a complete nested BRC Quote payload). It is distinct from the other brc_batch_* siblings by resource type, though it never contrasts itself with the single-record brc_create_quote, so the batch-vs-single distinction is left to the name.

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 clear operating context: max 100 items, a valid routeToken from the matching action workflow, and the preview-then-confirmWrite sequence required before anything is written. It does not name an alternative tool (e.g. brc_create_quote for a single quote) or state explicit when-not-to-use conditions, so it stops short of a 5.

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.