Search Shopify documentation to locate relevant answers and source links. Query by prompt and API name, with configurable result limits, without exposing store credentials.
Search Shopify documentation and return source links. No store credentials are sent.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | ||
| api_name | No | admin | |
| max_num_results | No |
Changes observed during successful MCP inspections.
v1.6.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so no mutation risk is hidden. The description adds behavioral context beyond the annotations by specifying that the tool returns source links and that no store credentials are sent. It does not describe chunking or pagination behavior, but the annotations lower the burden for safety-related disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences with no filler. The first sentence front-loads the core action and output, and the second sentence adds a meaningful behavioral/security trait. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a relatively simple tool with rich annotations, and the description does convey that it searches docs and returns source links, making it minimally usable. However, api_name is left unexplained, there is no output schema to clarify return structure, and there is no guidance on result count semantics, so clear gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate for undocumented parameters. It indirectly implies that 'prompt' is the documentation query, but it does not explain 'api_name' or 'max_num_results.' An agent would not know what api_name values are valid or how result limiting behaves, making this a clear gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: 'Search Shopify documentation' and states the deliverable: 'return source links.' This clearly distinguishes it from sibling tools that operate on store data, products, orders, or GraphQL schema rather than documentation search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context for when to use the tool: whenever an agent needs to search Shopify documentation. It also adds the useful note that no store credentials are sent, which helps frame it as a safe documentation lookup. However, it does not explicitly name alternatives or when-not-to-use conditions, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.