Skip to main content
Glama

Red by Big Red Cloud

Get Cash Payment

brc_get_cash_payment
Read-only

Gets one BRC cash payment by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCash payment 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.6/5.0
Behavior3/5

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

Annotations already provide readOnlyHint=true, openWorldHint=false, and destructiveHint=false, covering the read-only safety profile. The description adds only the fetch-by-id behavior; it does not disclose anything about return shape, not-found behavior, errors, or required contextual setup. The interesting detail about reusing connectionRef is located in the schema, not in the description, so the description alone carries limited behavioral insight.

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?

The description is a single, direct sentence with no filler words: 'Gets one BRC cash payment by id.' It is efficiently front-loaded, though it lacks extra helpful context such as a pointer to list/batch alternatives or return details.

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?

This is a simple single-fetch tool with required parameters and no output schema, so the description's minimal text is close to adequate. Yet it still leaves gaps: no mention of response content, error handling for missing ids, any prerequisites like an active connection state, or the connectionRef reuse guidance being present only in the schema.

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 input schema has 100% parameter description coverage, including 'id' as 'Cash payment id', 'companyName' with an example, and a detailed explanation of 'connectionRef'. The description 'by id' only reinforces what the schema already states, so it adds no new parameter meaning beyond the structured field descriptions.

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 states a specific action ('Gets'), a distinct resource ('BRC cash payment'), and the selection criterion ('by id'), clearly differentiating it from brc_list_cash_payments, brc_batch_cash_payments, brc_create_cash_payment, and brc_update_cash_payment. It is not a tautology of the tool name and leaves no ambiguity about returning a single entity.

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?

The phrase 'one ... by id' implies this tool is for retrieving exactly one specified cash payment, rather than lists, batches, or mutations. However, the description does not explicitly state when to prefer this over the sibling 'list' or 'batch' tools, nor does it mention when-not-to-use it or require aspects missing from the description.

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.