Skip to main content
Glama

List learned counterparty rules

list_counterparty_rules
Read-only

Lists the org's persistent counterparty rules — the learned vendor map that auto-classifies future events so they skip review. Each rule carries its id, the normalised counterparty_key it matches, the direction it is scoped to (inbound = money in, outbound = money out, null = both), the target account (code + name), and when it was created and last updated. Use update_counterparty_rule to re-point a rule or delete_counterparty_rule to remove one — both affect future classification only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
org_idNoOptional. Defaults to the organisation the authenticated API key is bound to, so you normally omit it and never need to ask the user for their organisation UUID. If provided, it must match the key’s org or the request is rejected.0e91146d-511c-469f-bdee-5c867b26ae0d

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rulesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds meaningful behavioral context: the rules are persistent, auto-classify future events, and skipping review is a consequence of the learned map. It also clarifies the direction field semantics (inbound/outbound/null = both), which is beyond what annotations provide. Minor gap: no mention of pagination or ordering, but not critical for a list tool.

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?

Three sentences, each earning its place: the first defines the resource and its purpose, the second enumerates the returned fields, and the third routes to sibling tools. Information is front-loaded and there is zero filler.

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

Completeness5/5

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

The tool is a simple read-only list with one optional parameter, a rich output schema, and full schema coverage. The description explains the domain significance (learned vendor map, skip review), the returned fields, and the modification alternatives. Nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100% and the single parameter org_id is fully documented in the schema, including its default and the fact that it can be omitted. The description reinforces this by saying 'you normally omit it and never need to ask the user for their organisation UUID' — adding practical guidance beyond the schema. Baseline 3 is exceeded because the description adds real usage nuance.

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 verb ('Lists') and resource ('the org's persistent counterparty rules'), and immediately distinguishes it from sibling tools by explaining what the rules do (auto-classify future events so they skip review). It also names sibling tools update_counterparty_rule and delete_counterparty_rule, making the purpose unmistakable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says when to use this tool (to view the learned vendor map) and names the alternatives for modifying rules (update_counterparty_rule, delete_counterparty_rule), noting they affect future classification only. This gives clear routing guidance without needing to inspect sibling schemas.

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.

Resources