Skip to main content
Glama
AIWerk

shopify

by AIWerk

shopify_get_product

Get a Shopify product by GID or numeric ID, returning full detail including variants, images, and truncation markers when capped.

Instructions

Get a product by GID or numeric ID (e.g. "gid://shopify/Product/123" or "123"). Returns full product detail including variants and images, with truncation markers when capped.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
Behavior4/5

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

With no annotations, the description carries full burden. It discloses that the tool returns 'full product detail including variants and images' and mentions 'truncation markers when capped', which informs the agent about potential output limits. However, it does not specify error handling or permission requirements.

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

Conciseness5/5

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

The description is extremely concise: two sentences with no extraneous words. The first sentence states purpose and parameter format; the second describes output. Every sentence adds value.

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?

Given the tool has a single parameter, no output schema, and no annotations, the description covers purpose, parameter format, and return content. It could be improved by mentioning error scenarios or access prerequisites, but it provides a solid baseline for a simple retrieval operation.

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

Parameters5/5

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. It clearly explains the parameter 'id' accepts two formats (GID or numeric ID) with examples, which is essential for correct invocation. This fully addresses the missing schema documentation.

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 product by GID or numeric ID. The verb 'Get' and resource 'product' are unambiguous. It distinguishes itself from sibling tools like shopify_get_customer or shopify_get_order by specifying the resource type.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives like shopify_search_products or shopify_list_products. The context of having a specific ID is implied but not stated, and no exclusions or conditions are provided.

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