Skip to main content
Glama

Red by Big Red Cloud

Get Supplier

brc_get_supplier
Read-only

Gets one BRC supplier by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSupplier id.
companyNameYesCompany context name, for example YOUR-COMPANY-NAME.
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. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the read-only nature is fully covered. The description does not add behavioral detail like not-found behavior or company context requirements, but it also does not contradict the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no wasted words. 'Gets one BRC supplier by id' is direct, front-loaded, and perfectly sized for a simple getter.

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 basic get-by-id operation, the description plus the rich schema and read-only annotations is largely complete. The only missing context is explicit handling of missing/empty results or the reason for the required companyName, but these are minor given the full schema descriptions.

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 each parameter is already documented in detail. The description adds no parameter-specific guidance beyond 'by id', but the schema already carries the full semantic burden for id, companyName, and connectionRef.

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

Purpose5/5

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

The description uses a specific verb ('Gets'), a specific resource ('one BRC supplier'), and the lookup criterion ('by id'). It clearly distinguishes this tool from listing tools like brc_list_suppliers and brc_batch_suppliers, so an agent can immediately understand it is the single-item lookup.

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 context is implied: use this when you need one supplier by id. However, the description does not explicitly mention alternatives or say when not to use it, such as when retrieving opening balances or supplier lists. The agent must infer the appropriate 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.