Red by Big Red Cloud

Batch Customers

brc_batch_customers

Destructive

Processes a batch of customers using explicit identity, VAT classification, and optional contact 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_customers"
  }
}

Input Schema

Name	Required	Description
`items`	Yes	Batch items to process. Maximum 100 items per request.
`routeToken`	Yes	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.
`companyName`	Yes	Company context name, for example YOUR-COMPANY-NAME.
`confirmWrite`	No	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.
`connectionRef`	No	Opaque 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.
`detailedResponse`	No	Return full payload and BRC response for audit inspection. Default is compact.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedOct 21, 2026

addedInput schema / properties / detailedResponse

Added value: +{
+  "description": "Return full payload and BRC response for audit inspection. Default is compact.",
+  "type": "boolean"
+}

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
```

Changed6 schema fields changedAug 25, 2026

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": {
+      "additionalEmails": {
+        "description": "Optional additional email addresses.",
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "address": {
+        "description": "Optional address lines.",
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "businessIdentifierCode": {
+        "description": "Optional BIC. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "code": {
+        "description": "BRC account code, maximum eight characters.",
+        "maxLength": 8,
+        "minLength": 1,
+        "type": "string"
+      },
+      "contact": {
+        "description": "Optional contact name. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "creditTerms": {
+        "description": "Optional credit terms in days.",
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "email": {
+        "description": "Optional email address. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "fax": {
+        "description": "Optional fax number. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "internationalBankAccountNumber": {
+        "description": "Optional IBAN. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "mobile": {
+        "description": "Optional mobile number. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "name": {
+        "description": "Customer or supplier name.",
+        "minLength": 1,
+        "type": "string"
+      },
+      "phone": {
+        "description": "Optional phone number. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "vatAnalysisTypeId": {
+        "description": "BRC VAT analysis type id.",
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "vatReg": {
+        "description": "Optional VAT registration number. Blank values are accepted and omitted by the existing builder.",
+        "type": "string"
+      },
+      "vatRegistered": {
+        "description": "Whether the owner is VAT registered.",
+        "type": "boolean"
+      },
+      "vatType": {
+        "description": "BRC VAT type integer. Resolve the intended value from the connected company's VAT reference data.",
+        "exclusiveMinimum": 0,
+        "maximum": 9007199254740991,
+        "type": "integer"
+      }
+    },
+    "required": [
+      "code",
+      "name",
+      "vatType",
+      "vatAnalysisTypeId"
+    ],
+    "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"
-}

Changed2 schema fields changedAug 5, 2026

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"
+]

Changed2 schema fields changedAug 4, 2026

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"
+]

Changed2 schema fields changedAug 4, 2026

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"
+]

First observedJul 30, 2026

TDQS

A4.3/5.0

Behavior5/5

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

Annotations already flag destructiveHint=true and readOnlyHint=false, and the description adds substantial context beyond that: the 100-item cap, the preview-before-posting requirement, that confirmWrite: true applies the previewed change, that routeToken does not bypass preview, and that preflight is not confirmation. This is exactly the behavioral detail an agent needs to avoid an accidental write.

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 purpose, then the token/confirmation workflow in short declarative sentences. A couple of sentences ("Passing preflight is not confirmation," "A routeToken does not bypass preview...") are near-redundant, but they guard against high-cost misuse and each carries distinct meaning.

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?

For a destructive batch-create tool with no output schema, the description covers the full guardrail workflow (token source, preview, confirmation, limits) that the annotations alone cannot express. An agent has everything needed to call it safely without additional resources.

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 description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by explaining the live semantics of routeToken (valid through lookup/preview/transaction) and confirmWrite (must reflect a shown preview plus explicit user confirmation), plus the 100-item batch limit, which clarifies how items and confirmWrite are meant to be used together.

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 customers") and names the fields involved (identity, VAT classification, contact). It is clearly distinguishable from the many sibling brc_batch_* tools by its resource. However, "Processes" is softer than the actual operation, which the schema reveals as a create (opCode const 1), so the intent is slightly less precise than it could be.

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 operational context: a routeToken from the matching action workflow is required, the token spans lookup/preview/transaction, placeholder tokens fail, and confirmWrite gating is described. It does not explicitly contrast with brc_create_customer (single-record) or name when a caller should prefer batch over single, so sibling routing is left implicit.

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

All Red by Big Red Cloud tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Batch Customers

Tool call template

Input Schema

Schema Changelog

TDQS

Glama MCP Gateway

Resources