Skip to main content
Glama
BenjaminJ

enterprise-mcp-gateway

by BenjaminJ
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Hybrid

listCustomers

Search and browse enterprise customer profiles by status, returning paginated summaries with customer IDs for subsequent detail lookups.

Instructions

List and search enterprise customer profiles - Retrieves a paginated list of enterprise customer profiles.

[Usage Guidelines]

  • When to use: Use this tool to discover, search, or browse customer records across the organization, or to find a customerId before calling detail tools.

  • When NOT to use: Do NOT use this tool if you already have a specific customerId and need full profile or contact attributes; use 'getCustomerDetails' instead. Do NOT use to inspect customer billing or invoices; use 'getBillingHistory' instead.

  • Alternatives: Use 'getCustomerDetails' for single-record deep inspection.

[Behavior]

  • Operation: Read-only and idempotent. Safe to call multiple times with identical parameters without side effects.

  • Authorization: Requires 'readonly_agent', 'support_agent', or 'admin' role.

  • DLP / Sanitization: Customer email addresses and account statuses are returned. Any internal notes are scrubbed.

[Parameters & Interactions]

  • 'status' (query, optional): Filter by lifecycle state ('active', 'inactive', 'suspended'). If omitted, customers in all lifecycle states are returned.

  • 'limit' (query, optional): Integer between 1 and 100 specifying maximum records to return per page. Defaults to 20 if omitted.

[Returns]

  • Returns a JSON array of customer summary objects, each containing: customerId (string, e.g. 'cust-001'), name (string), email (string), and status (string).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of customer records to return in a single page (integer between 1 and 100). Defaults to 20 when omitted. Use smaller limits (e.g. 5-10) for faster LLM processing context.
statusNoFilter customers by account lifecycle status. Valid values are 'active' (in good standing), 'inactive' (dormant), or 'suspended' (past due or locked). Leave empty to retrieve accounts across all lifecycle states.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.3
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of customer records to return in a single page (between 1 and 100). Defaults to 20."New value: +"Maximum number of customer records to return in a single page (integer between 1 and 100). Defaults to 20 when omitted. Use smaller limits (e.g. 5-10) for faster LLM processing context."
    • changedInput schema / properties / status / description
      Previous value: -"Filter customers by account lifecycle status (e.g., 'active', 'inactive', or 'suspended'). Leave empty to retrieve all statuses."New value: +"Filter customers by account lifecycle status. Valid values are 'active' (in good standing), 'inactive' (dormant), or 'suspended' (past due or locked). Leave empty to retrieve accounts across all lifecycle states."
  2. Changed8 schema fields changedv1.0.1
    • addedInput schema / properties / limit / default
      Added value: +20
    • changedInput schema / properties / limit / description
      Previous value: -"Max records to return"New value: +"Maximum number of customer records to return in a single page (between 1 and 100). Defaults to 20."
    • addedInput schema / properties / limit / example
      Added value: +10
    • addedInput schema / properties / limit / maximum
      Added value: +100
    • addedInput schema / properties / limit / minimum
      Added value: +1
    • changedInput schema / properties / status / description
      Previous value: -"Filter customers by active/inactive status"New value: +"Filter customers by account lifecycle status (e.g., 'active', 'inactive', or 'suspended'). Leave empty to retrieve all statuses."
    • addedInput schema / properties / status / enum
      Added value: +[
+  "active",
+  "inactive",
+  "suspended"
+]
    • addedInput schema / properties / status / example
      Added value: +"active"
  3. First observedv1.0.0

TDQS

A4.5/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden, and it succeeds: it declares the operation read-only and idempotent, lists required authorization roles, and discloses DLP sanitization behavior. This goes well beyond a generic API description.

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 well-structured with clear labeled sections and a concise front-loaded summary. It is slightly repetitive with the schema in the parameters section, but the overall organization makes the length acceptable and scannable.

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?

For a simple two-parameter list tool with no annotations and no output schema, the description covers returns, authorization, sanitization, and usage guidance well. The only notable gap is that 'paginated' is mentioned but no pagination navigation mechanism (e.g., cursor, offset, or next-page token) is described, and 'search' in the title is not backed by a search-text parameter.

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 largely restates the schema's parameter details for 'status' and 'limit' without adding significant new semantics beyond what the schema already documents.

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 opens with a specific verb and resource: 'List and search enterprise customer profiles' and clarifies it returns a paginated list of summaries. It distinguishes itself from siblings by directing deep single-record lookups to 'getCustomerDetails' and billing to 'getBillingHistory'.

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 [Usage Guidelines] section explicitly states when to use the tool, when NOT to use it, and names alternatives with exact tool names. An agent can confidently route between listCustomers, getCustomerDetails, and getBillingHistory without ambiguity.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools