Skip to main content
Glama

Red by Big Red Cloud

Get Payment

brc_get_payment
Read-only

Gets one BRC payment by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPayment 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?

The annotations already disclose readOnlyHint=true and destructiveHint=false, and the description aligns with those. It adds no meaningful behavioral context beyond "gets," such as behavior on missing IDs, response shape, or permissions, but it 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 extremely succinct, about six words, and front-loads the key verb plus the resource. There is zero redundancy or unnecessary detail, which is appropriate for a simple get-by-id tool.

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 straightforward read-only operation with only three params, the description, schema, and annotations provide enough to invoke the tool correctly. The main omission is a more explicit note distinguishing this from brc_get_cash_payment and clarifying what a returned payment record looks like in a real Payment with no output 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% description coverage and already explains all three parameters, including the required companyName and id and the optional connectionRef. The description itself adds no new parameter-level semantics, so it meets the schema-covered baseline of 3.

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 uses the specific verb "Gets" and names the precise resource "one BRC payment" and the lookup method "by id," so the core action is unambiguous. It differentiates from list/batch tools, but it does not explicitly clarify the distinction from related get tools such as brc_get_cash_payment.

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 "by id" wording implies this tool is for fetching a single known payment rather than listing or batching, but there is no explicit when-to-use or when-not-to-use guidance. The description does not mention alternatives, so the agent is left to infer the usage boundary from the tool name and phrasing.

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.