Skip to main content
Glama

list_counterparties

List a company's counterparties (filter by kind/q, paginated).

kind repeats to filter on a set (?kind=customer&kind=both) — a role-shaped picker asks for every kind that plays the role. A single ?kind=supplier keeps its original meaning.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "company_id": "<company_id>"
    },
    "name": "list_counterparties"
  }
}

Input Schema

NameRequiredDescriptionDefault
qNo
kindNo
limitNo
offsetNo
company_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / kind / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "description": "Master-data axis of a counterparty (what the party primarily is).\n\n``employee`` (payroll SP1, brief frozen decision 6) is set **only** on\ncounterparties auto-created by ``payroll.master_data\n.ensure_employee_counterparty`` and is terminal — matching/merge flows never\nwiden it to ``both``. Subledger participation rides the richer\n``gl_counterparty_role`` table; payroll logic never branches on ``kind``.",
      -      "enum": [
      -        "supplier",
      -        "customer",
      -        "both",
      -        "employee"
      -      ],
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "description": "Master-data axis of a counterparty (what the party primarily is).\n\n``employee`` (payroll SP1, brief frozen decision 6) is set **only** on\ncounterparties auto-created by ``payroll.master_data\n.ensure_employee_counterparty`` and is terminal — matching/merge flows never\nwiden it to ``both``. Who is an employee is ``gl_employee.counterparty_id``\n(ZEN-958 L4 retired the ``gl_counterparty_role`` projection); payroll logic\nnever branches on ``kind``.",
      +      "enum": [
      +        "supplier",
      +        "customer",
      +        "both",
      +        "employee"
      +      ],
      +      "type": "string"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description must carry the behavioral burden. 'List' implies a read-only operation and 'paginated' discloses result batching, and the repeated-kind explanation reveals filtering behavior beyond the schema. However, it says nothing about permissions, ordering, or what a counterparty record contains, leaving gaps for an agent unfamiliar with the domain.

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 short and front-loads the core purpose before the filter detail. The backtick markup and the cryptic phrase 'a role-shaped picker asks for every kind that plays the role' add a little noise, but overall there is little wasted text.

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 five-parameter, non-destructive listing tool with no annotations and no output schema, the definition covers purpose, filtering, and pagination adequately. It falls short on describing the returned counterparty shape and on any error or permission behavior, which an agent calling it cold would still want.

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 essentially absent for the top-level parameters, so the description must compensate. It successfully explains that kind is repeatable and how a set-valued kind is interpreted, which the schema's array type alone does not convey, but it leaves q, limit, offset, and company_id entirely to inference (only 'paginated' gestures at limit/offset).

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 opens with a specific verb and resource ('List a company's counterparties') and names the two filter axes and pagination. It is clearly distinguishable from the other list_* siblings (invoices, accounts, items) without needing comparison, but it never explicitly contrasts itself with a broader search tool like global_search.

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?

It gives real guidance on how to use the kind filter (repeat for a set, single value keeps original meaning), which resolves a genuine ambiguity. It offers no guidance on when to choose this tool over alternatives such as global_search or entry_candidates, so tool-selection context is only implied by the list semantics.

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