Skip to main content
Glama

list_customers

Search and retrieve a list of customers by name, email, or phone. Returns customer IDs, names, emails, phones, tags, and creation dates.

Instructions

取得客戶列表,支援依關鍵字搜尋客戶。

【用途】 查詢特定客戶或瀏覽客戶清單。可用姓名、email、電話搜尋。 若要取得單一客戶的完整資訊(含儲值金、點數、等級),請改用 get_customer_profile。

【呼叫的 Shopline API】

  • GET /v1/customers(無搜尋條件時)

  • GET /v1/customers/search(有搜尋條件時)

【回傳結構】 dict 含 total_found, returned, customers[]。 每個 customer 包含 id, name, email, phone, tags, created_at。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
search_keywordNo搜尋關鍵字(姓名、email、電話)
max_resultsNo最多回傳筆數
Behavior5/5

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

Discloses the underlying API endpoints used depending on search conditions (GET /v1/customers vs GET /v1/customers/search). Describes the return structure including fields like total_found, returned, customers[] with id, name, etc. No contradictions since no annotations are provided.

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?

Well-structured with distinct sections for purpose, usage, API calls, and return structure. Content is front-loaded and efficient, though including API endpoints and return structure may be slightly verbose but adds utility.

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?

Given no output schema, the description fully compensates by detailing the return structure and API behavior. It also mentions the alternative tool for complete profiles, making it complete for a list tool.

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 100% so baseline is 3. The description adds value by explaining the search_keyword triggers a different API endpoint and clarifies the return structure, providing context beyond the schema's parameter descriptions.

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 clearly states the tool retrieves a customer list with keyword search support. It distinguishes itself from get_customer_profile by noting that tool provides full details including store credit, points, and tier.

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?

Explicitly states when to use this tool (querying specific customers or browsing the list) and when to use the alternative get_customer_profile for complete individual data. Provides clear search capabilities by name, email, or phone.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/asgard-ai-platform/mcp-shopline'

If you have feedback or need assistance with the MCP directory API, please join our Discord server