Skip to main content
Glama

List clients

list_clients
Read-only

List all clients with optional filtering and pagination

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (0-indexed)
limitNoResults per page
orderNoSort order: asc or desc
searchNoSearch by client name
sort_byNoField to sort by
folder_idNoFilter by folder ID (from list_folders)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoOne row per client — id, name, website, currency, timezone, logo_url, the folders it is filed under, and its connected datasources.
metaNoPage, limit and total row count.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / meta / description
      Previous value: -"Pagination for the list — page, limit and the total row count."New value: +"Page, limit and total row count."
    • changedOutput schema / properties / meta / properties / limit / description
      Previous value: -"Maximum rows per page."New value: +"Max rows per page."
    • changedOutput schema / properties / meta / properties / page / description
      Previous value: -"Zero-based index of the page returned."New value: +"Page index, zero-based."
    • changedOutput schema / properties / meta / properties / total / description
      Previous value: -"Total rows matching the query across all pages."New value: +"Total rows matching the query."
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "description": "One row per client — id, name, website, currency, timezone, logo_url, the folders it is filed under, and its connected datasources.",
      +      "items": {},
      +      "type": "array"
      +    },
      +    "meta": {
      +      "additionalProperties": true,
      +      "description": "Pagination for the list — page, limit and the total row count.",
      +      "properties": {
      +        "limit": {
      +          "description": "Maximum rows per page.",
      +          "type": "number"
      +        },
      +        "page": {
      +          "description": "Zero-based index of the page returned.",
      +          "type": "number"
      +        },
      +        "total": {
      +          "description": "Total rows matching the query across all pages.",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds the notion of 'optional filtering and pagination', which is a minor behavioral trait. It does not describe pagination defaults, result structure, or any side effects beyond what annotations imply. Adds some value but not rich context.

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?

The description is a single, focused sentence that states the core purpose and key features. It is front-loaded and contains no filler. For a simple list operation, this length is appropriate.

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?

With an output schema present and annotations covering safety, the description is largely sufficient. It covers the core operation, though it omits details like default pagination limits or how filtering interacts with search. These are minor gaps for a read-only list tool, making it adequate but not exhaustive.

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 baseline is 3. The description merely echoes 'optional filtering and pagination' without adding parameter-specific meaning beyond the schema. No extra semantics provided for page, limit, order, search, sort_by, or folder_id.

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 'list' and the resource 'clients', with 'all clients' indicating scope. It distinguishes from get_client (singular) and count_clients (count) implicitly, but does not explicitly name alternatives. Clear but not strongly differentiated from siblings.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives like get_client or count_clients. The description only states what it does, not when to choose it, nor does it mention exclusions or prerequisites. No context for selection.

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