Skip to main content
Glama
AIWerk

shopify

by AIWerk

shopify_search_customers

Search customers using Shopify query syntax, e.g., email:foo@bar.com. Returns matching records.

Instructions

Search customers by Shopify search query (e.g. "email:foo@bar.com OR last_name:Smith"). Required: query.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
firstNo
afterNo
sortKeyNo
reverseNo
Behavior2/5

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

With no annotations provided, the description carries the full burden. It only states 'Search customers' and gives a query example, but does not disclose behavior such as read-only nature, pagination behavior, rate limits, or whether the search is full-text or exact match.

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 very short, one sentence plus an example, which is appropriately front-loaded. However, it could be slightly expanded to cover other key parameters without being verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 5 parameters, no output schema, and no annotations, the description is too minimal. It does not explain pagination, sorting, result format, or prerequisites, leaving the agent without enough context for effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%. The description adds meaning only to the 'query' parameter by showing its format. The other four parameters (first, after, sortKey, reverse) are not mentioned, leaving them fully undocumented in terms of usage.

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 searches customers by a Shopify search query, with a specific example. It distinguishes from siblings like shopify_get_customer (single customer by ID) and shopify_list_customers (no query filter).

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?

The description indicates the query parameter is required and provides an example of its format, but it does not explicitly state when to use this tool over alternatives like shopify_list_customers or shopify_get_customer, nor does it mention any exclusions.

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/AIWerk/mcp-server-shopify'

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