Skip to main content
Glama

Red by Big Red Cloud

List Payments

brc_list_payments
Read-only

Lists BRC payments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topNo
pageNo
skipNo
filterNoOptional OData $filter expression, only if this endpoint supports filtering.
orderByNoOptional OData $orderby expression, only if this endpoint supports ordering.
pageSizeNo
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
Behavior3/5

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the description is not responsible for stating safety and mutability. Beyond that, it adds no behavioral context such as whether the result is full and paginated, whether a connectionRef is needed, or whether the list is restricted to a current company context.

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 one sentence, front-loaded, and has no padding. It is concise without being verbose; however, it is near the point of too-to for a schema with eight parameters and multiple related sibling tools.

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

Completeness2/5

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

Given eight parameters, no output schema, and a huge sibling set that includes brc_list_cash_payments and brc_get_payment, one sentence is not enough. The description does not help with deciding payment versus cash_payment, connectionref usage, pagination semantics, or what data is actually returned.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 50%, but the description contributes no parameter-level meaning at all. Top, page, skip, and pageSize remain undocumented in schema and in description, and no explanation is given for how those pagination parameters interact with each other. An agent would have to infer or experiment.

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 says 'Lists BRC payments,' which is a clear verb+behavior statement: it returns a list of payment records. It does not differentiate itself from the close sibling tool brc_list_cash_payments, so an agent could still be unable to choose between them.

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 when-to-use guidance, no alternation, no exclusion, and no condition. The description does not point to brc_get_payment for a single payment, brc_create_payment for creating one, or brc_list_cash_payments for cash payments, so the agent only learns what the tool itself does, not when it should be preferred.

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.