Skip to main content
Glama

List clients

list_clients
Read-onlyIdempotent

Use this when the user asks about their clients, who owes them money, a client's balance, or needs a client_id for another tool. Lists clients of one business by name: id, name, company, TRN, type, outstanding balance in AED (unpaid issued invoices after payments and credits, foreign invoices at their exchange rate), unused credit in AED, and issued invoice count and total in AED, as the Clients page shows them. search matches the name. No email, phone or address. Do not use it for a client's statement over a period (get_client_statement) or to add a client (create_client).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_clients"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoPage size, 1 to 50. Default 20.
cursorNonext_cursor from the previous page, with the same filters.
searchNo
business_idNoFrom list_businesses. May be left out when the connection shares exactly one business.
with_balanceNoOnly clients with an outstanding balance.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already establish read-only, idempotent, non-destructive, closed-world behavior, so the description is free to add the data semantics that annotations cannot: balance means unpaid issued invoices after payments and credits, foreign invoices converted at their exchange rate, values in AED, and the result mirrors the Clients page. It also discloses negative coverage by stating no email, phone or address is returned, which prevents the agent from promising those fields.

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?

Front-loaded with the trigger and negative routing, then the field list; every sentence carries information with no filler. The single long sentence enumerating return fields is dense but readable, and nothing is wasted.

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?

With no output schema, the description must describe return values, and it does so field by field including units (AED) and computation rules for the two derived amounts. Combined with the exclusion routing and the note on absent contact fields, an agent has everything needed to call it correctly and interpret the response.

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 80%, so baseline is 3; the description earns an extra point by explaining that "search matches the name" (scope of the match) and by clarifying the business scoping implicitly tied to "one business". It says nothing about with_balance's effect or paging behavior via cursor, so it does not fully compensate for the undocumented parameters.

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?

States a specific verb and resource ("Lists clients of one business") and enumerates the returned fields, so the agent knows exactly what this returns. It explicitly separates itself from get_client_statement and create_client by name, so no sibling confusion is possible.

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?

Opens with concrete trigger conditions (user asks about clients, who owes money, a client's balance, or needs a client_id for another tool) and closes with explicit exclusions naming the alternatives (get_client_statement for period statements, create_client to add). Both when-to-use and when-not-to-use are covered.

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