Skip to main content
Glama

Red by Big Red Cloud

Batch Products

brc_batch_products
Destructive

Processes a batch of products using explicit product type, VAT classification, price, and description fields. 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.

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_products"
  }
}

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.

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. Changed6 schema fields changed
    • removedInput schema / properties / confirmCrAnalysisCategory
      Removed value: -{
      -  "description": "Applies 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.",
      -  "type": "boolean"
      -}
    • changedInput schema / properties / items / items / additionalProperties
      Previous value: -{}New value: +false
    • addedInput schema / properties / items / items / properties
      Added value: +{
      +  "item": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "details": {
      +        "description": "One or more non-empty product description lines.",
      +        "items": {
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "grossUnitPrice": {
      +        "description": "Whether unitPrice is VAT-inclusive.",
      +        "type": "boolean"
      +      },
      +      "hasDefaultVatRate": {
      +        "description": "Whether the product uses its selected default VAT rate.",
      +        "type": "boolean"
      +      },
      +      "productTypeId": {
      +        "description": "BRC product type id. Select the intended product type explicitly.",
      +        "exclusiveMinimum": 0,
      +        "maximum": 9007199254740991,
      +        "type": "integer"
      +      },
      +      "stockCode": {
      +        "description": "BRC product code. BRC may enforce additional server-side code limits.",
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "unitPrice": {
      +        "description": "Product unit price. Zero is valid for products whose price is supplied at transaction time.",
      +        "minimum": 0,
      +        "type": "number"
      +      },
      +      "vatAnalysisTypeId": {
      +        "description": "BRC product VAT analysis type id.",
      +        "maximum": 9007199254740991,
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "vatRateId": {
      +        "description": "BRC VAT rate id. Select the intended VAT rate explicitly.",
      +        "exclusiveMinimum": 0,
      +        "maximum": 9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "stockCode",
      +      "details",
      +      "productTypeId",
      +      "vatRateId",
      +      "vatAnalysisTypeId",
      +      "unitPrice",
      +      "grossUnitPrice",
      +      "hasDefaultVatRate"
      +    ],
      +    "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

A3.9/5.0
Behavior4/5

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

The description adds meaningful safety context beyond the destructiveHint annotation: preview before write, explicit confirmation, and confirmation-only writes. It still does not explain whether the batch is atomic, what happens on partial failure, or exactly which product records are created or changed.

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 purpose and batch limit are front-loaded, and the safety workflow is clearly stated. The later sentences about routeToken, preview, confirmWrite, and preflight are somewhat repetitive, but not wasteful enough to undermine the definition.

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 tool with rich schema coverage and annotations, the description covers the critical safety workflow, token constraints, and item limit. It leaves minor gaps around success/error semantics and partial batch behavior, but the core invocation context is present.

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 the schema already documents routeToken, confirmWrite, companyName, and nested item fields. The description reinforces the batch limit and confirmation semantics but adds little new parameter-level meaning 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 description states a specific batch operation over product records and names the key fields used (product type, VAT classification, price, description). It distinguishes this as a batch tool, but it never explicitly says it creates new product records and does not contrast with the singular brc_create_product sibling.

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 clearly explains the batch limit, routeToken requirement, and the confirmWrite preview-confirmation flow. However, it does not explicitly say when to choose this over brc_create_product or other product-writing paths beyond the implied batch 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.