Skip to main content
Glama

Red by Big Red Cloud

Get Sales Credit Note

brc_get_sales_credit_note
Read-only

Gets one BRC sales credit note by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSales credit note 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

B3.4/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 agent knows this is a safe read operation. The description adds the singular 'by id' semantic but does not provide additional behavioral context such as missing-record behavior, authorization needs, or rate limits. This is acceptable because the annotations carry the safety profile.

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 core operation is front-loaded. It is appropriately concise, though it adds little beyond the tool name and could include a small note about return behavior without sacrificing brevity.

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?

For a single-record getter with a relatively simple input contract, the description is basically sufficient. There is no output schema, and the description does not indicate whether the tool returns a single object, returns null on missing ids, or throws an error. This is not critical for an agent to try calling it, but it leaves some return-behavior ambiguity.

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?

Schema description coverage is 100%, so the input schema already documents id, companyName, and connectionRef, including the important session-rotation guidance for connectionRef. The description does not add parameter-level detail, but the schema handles that responsibility well. This matches the baseline where structured descriptions do the heavy lifting.

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 verb and resource: 'Gets one BRC sales credit note by id.' It is distinguishable from list and batch siblings because it scopes the call to a single credit note and requires an id. It is specific and unambiguous, though it does not explicitly name related siblings.

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 usage: when you have a credit note id and need one record. It does not mention when to prefer brc_list_sales_credit_notes or brc_batch_sales_credit_notes. There is no explicit when-to-use or exclusions, so usage guidance is adequate but not strong.

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.