Skip to main content
Glama

Red by Big Red Cloud

Batch Suppliers

brc_batch_suppliers
Destructive

Processes a batch of suppliers 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_suppliers"
  }
}

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": {
      +      "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"
      -}
  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/5.0
Behavior5/5

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

With destructiveHint=true already declared, the description adds substantial context beyond annotations: token validity across lookup/preview/transaction, invalidity of placeholder tokens, the confirmation_required response with a payload preview, and the rule that passing preflight is not confirmation. This is exactly the mutation-safety detail an agent needs.

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 the batch scope and size limit, then the token and confirmation rules. It is a little repetitive on the confirmation theme (four sentences touch preview/confirmation), but each carries mostly distinct information.

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 write with no output schema, the description covers the token prerequisite, the confirmation gate, and the size cap. It does not describe the success return shape, but it does cover the intermediate confirmation_required response, so the gap is minor.

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, but the description adds meaning the schema does not fully spell out — the routeToken lifecycle ('remains valid through lookup, preview and the permitted transaction') and the named confirmation_required return on a non-confirmed call.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The verb 'Processes' is vague — it does not state that this tool creates suppliers, even though the schema pins opCode to 1 (create). It does establish batch scope and the 100-item limit, which distinguishes it from brc_create_supplier, but it never names that sibling or the closely related brc_batch_customers.

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?

Strong workflow guidance: it states the routeToken must come from brc_route_request, that placeholder tokens are invalid, and precisely when confirmWrite may be set (only after a preview and explicit user confirmation, never on the first call). It lacks explicit routing to alternatives such as brc_create_supplier for single-record work, 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.