Skip to main content
Glama

Search Customers Tool

search-customers
Read-only

Searches the authenticated workspace customers without exposing addresses, notes, or other private fields. Use to search customers in the connected business. Returns query, count, customers, id, name, email, phone, business_name, trade_type, lifecycle_tag, scope.

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": "search-customers"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of customers to return.
queryNoName, email, phone, or business name to search for.

Output Schema

NameRequiredDescriptionDefault
countYesNumber of customers returned in this bounded result.
queryYesSearch text, or null when no query was supplied.
scopeYesResults belong to the business bound to this OAuth connection.
customersYesSafe customer contact and lifecycle fields; excludes addresses and notes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "count": {
      +      "description": "Number of customers returned in this bounded result.",
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "customers": {
      +      "description": "Safe customer contact and lifecycle fields; excludes addresses and notes.",
      +      "items": {
      +        "properties": {
      +          "business_name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "email": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "id": {
      +            "type": "integer"
      +          },
      +          "lifecycle_tag": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "phone": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "trade_type": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "email",
      +          "phone",
      +          "business_name",
      +          "trade_type",
      +          "lifecycle_tag"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "query": {
      +      "description": "Search text, or null when no query was supplied.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "scope": {
      +      "description": "Results belong to the business bound to this OAuth connection.",
      +      "enum": [
      +        "connection_business"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "count",
      +    "customers",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover read-only, non-destructive, closed-world behavior, so the description is not obligated to restate safety. It earns credit by disclosing a privacy trait the annotations do not: certain fields (addresses, notes, other private fields) are deliberately withheld from results.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the useful scope statement, but the middle sentence ("Use to search customers in the connected business") duplicates the name and consumes space without adding information. The trailing field list is also largely redundant with the output schema.

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 read tool with full schema coverage, annotations, and an output schema, the definition supplies what an agent needs: the search scope and the privacy limitation on results. Only the missing contrast with get-customer leaves a small gap.

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 coverage is 100%, so query and limit are fully documented in the schema itself (including max 50, maxLength 80). The description adds no parameter-level meaning; its enumerated names are returned fields, not input parameters, and an output schema already covers those.

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?

States a specific verb (searches) and resource (authenticated workspace customers) and adds a scope constraint – private fields such as addresses and notes are excluded. It is clear enough to distinguish from get-customer, though it never explicitly contrasts with the single-record retrieval sibling.

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?

"Use to search customers in the connected business" implies context but is largely a restatement of the tool name; there is no explicit when-not guidance and no mention of get-customer as the alternative for fetching one known customer.

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