Skip to main content
Glama
Sign In

Red by Big Red Cloud

by io.github.BigRedCloud
OverviewDiscussionsAdmin

List Customers

brc_list_customers
Read-only

Lists BRC customers. customerCode uses exact case-sensitive bounded local lookup (10,000 records); BRC forbids customer OData filters.

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>"
    },
    "name": "brc_list_customers"
  }
}

Input Schema

NameRequiredDescriptionDefault
topNo
pageNo
skipNo
filterNoUnsupported: BRC customers forbid $filter. List with pagination and match locally.
orderByNoOptional OData $orderby expression, only if this endpoint supports ordering.
pageSizeNo
companyNameYesCompany context name, for example YOUR-COMPANY-NAME.
customerCodeNoExact case-sensitive code; bounded local filtering, no fuzzy match.
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. Changed1 schema field changed
    • addedInput schema / properties / customerCode
      Added value: +{
+  "description": "Exact case-sensitive code; bounded local filtering, no fuzzy match.",
+  "minLength": 1,
+  "type": "string"
+}
  2. Changed1 schema field changed
    • changedInput schema / properties / filter / description
      Previous value: -"Optional OData $filter expression, only if this endpoint supports filtering."New value: +"Unsupported: BRC customers forbid $filter. List with pagination and match locally."
  3. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds genuinely useful behavior beyond that: the 10,000-record bounded local lookup and the fact that BRC forbids server-side customer filters, which changes how the agent must post-filter results.

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?

Two dense sentences with no filler, and the core purpose is front-loaded before the constraint. Slightly compressed phrasing (semicolon-chained clauses) but nothing wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter list tool with no output schema, the description omits pagination semantics (top/page/skip/pageSize defaults) and the connectionRef reuse requirement, both of which matter for correct invocation. The schema carries those, so it is minimally viable rather than complete.

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 coverage is 56%, and the description's customerCode note largely restates the schema's own wording ('Exact case-sensitive code; bounded local filtering, no fuzzy match'). It adds only the 10,000-record bound, leaving parameters like top/page/skip/pageSize and connectionRef to 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?

States a clear verb+resource (lists BRC customers), so the agent immediately knows the operation. However, it does not distinguish this from close siblings like brc_list_customers_without_dormant or brc_batch_customers, leaving the agent to infer which listing variant applies.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: the note that BRC forbids customer OData filters tells the agent not to pass $filter, but there is no explicit when-to-use vs. the sibling list/batch tools or prerequisites (e.g. requiring an established connection).

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 toolsInspect
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.

Resources