Skip to main content
Glama

List clients

list_clients
Read-only

List all clients with optional filtering and pagination

Input Schema

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

Output 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. Changed4 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"Results per page"New value: +"Results per page, 1-100 (default 20)"
    • addedInput schema / properties / limit / maximum
      Added value: +100
    • addedInput schema / properties / limit / minimum
      Added value: +1
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
  2. 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."
  3. 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"
      +}
  4. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description only restates that filtering and pagination exist, which the schema already shows; it adds no auth, rate-limit, or default-page-size context.

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 tight sentence with no filler, front-loaded on the action and resource. It is slightly redundant in saying "all" while also promising optional filtering, but nothing is wasted.

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 a full output schema and complete parameter annotations, the description only needs to frame the operation, which it does. The remaining gap is routing — it never says when to reach for it instead of the many sibling list/get/count tools.

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% and every parameter (page, limit, order, search, sort_by, folder_id) carries its own enum, range, or cross-reference. The description adds no format or semantics beyond the schema, so the baseline of 3 applies.

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?

Clear verb+resource ("List all clients") with the scope modifiers (filtering, pagination) named up front. It does not distinguish itself from near-neighbours like get_client, count_clients, or search, so an agent must infer the difference from the names alone.

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 when-to-use guidance, no prerequisites, and no named alternative. Nothing tells the agent to prefer this over count_clients for a total, get_client for a single record, or search for a cross-resource lookup — the sibling set is large and overlapping.

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