Skip to main content
Glama

Red by Big Red Cloud

List Prepayments

brc_list_prepayments
Read-only

Returns a list of the company's Prepayments. Supports optional OData filtering by entryDate. Supports optional ordering by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topNoOptional page size.
skipNoOptional number of records to skip.
filterNoOptional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-03-01T00:00:00.
orderByNoOptional OData order by. Ordering is allowed by id, for example: id desc.
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 declare readOnlyHint and non-destructive behavior, so the bar for the description is lower. The description adds that only entryDate filtering and id ordering are supported, which is useful scoping context. It does not disclose pagination defaults, return format, or company-context behavior.

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?

two sentences communicates the primary purpose, supported filtering, and supported ordering with no wasted words. The most important information is front-loaded, which helps an agent scan the intent quickly.

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 list operation, the description covers the key decisions an agent needs to make including what is returned and which OData operations are allowed. There is no output schema, so a bit more detail about the returned prepayment fields would improve completeness, but the current description is not misleading.

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 covers all 6 parameters with descriptions. The tool description mostly restates what the schema already says, such as OData filtering by entryDate and ordering by id. Since schema coverage is 100%, the baseline applies and the description contributes little beyond the schema.

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 clearly states the action and target: 'Returns a list of the company's Prepayments.' It names the resource distinctly, which differentiates it from sibling tools like brc_list_accruals and brc_list_payments, though it does not explicitly call out those alternatives.

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 description implies use when a list of prepayments is needed, but does not provide explicit guidance on when to prefer this tool over related siblings such as brc_get_prepayment or brc_list_payments. It gives the caller useful filtering/ordering constraints but no exclusionary guidance.

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.