Skip to main content
Glama

Red by Big Red Cloud

List Customer Opening Balance Transactions

brc_list_customer_op_bal_trans
Read-only

Gets a customer's opening balance transaction list.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemIdYesCustomer item 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

C2.9/5.0
Behavior2/5

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

The description is consistent with the annotations but adds little beyond them. readOnlyHint and destructiveHint already communicate that this is a safe read operation; the description does not disclose return format, pagination behavior, or any other operational details beyond the fact that it returns a list.

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?

A single sentence with no filler and the main action described clearly. It is concise and easy to parse, although it uses its brevity to restate the title rather than include additional useful context.

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?

The description is minimally viable for a read-only list tool, and the schema covers parameter meanings. However, with no output schema and many similar sibling list tools, the lack of return-shape context or guidance on scope makes it incomplete in context.

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?

The schema already provides 100% documentation coverage for the three parameters, including the nuance around connectionRef. The description itself adds no parameter-level meaning, which is acceptable under the baseline but does not enhance understanding of what values to pass.

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 verb and resource: it 'Gets a customer's opening balance transaction list.' This is clear and distinct from generic list tools, though it does not explicitly differentiate itself from close siblings such as brc_get_customer_opening_balance or brc_list_customer_account_trans.

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

Usage Guidelines2/5

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

There is no guidance about when to choose this tool over alternatives. The description does not mention whether it is only for opening-balance transactions, how it differs from brc_list_customer_account_trans, or when the summary-style brc_get_customer_opening_balance would be more appropriate.

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.