Skip to main content
Glama
hamzashahbaz

Shopify MCP Server

by hamzashahbaz

shopify_sales_by_channel

Analyze sales performance across different channels like Online Store and POS to identify revenue sources and optimize channel strategy.

Instructions

Get sales breakdown by sales channel (Online Store, POS, etc.).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sinceNoStart date. Examples: '-30d', '-3m'
untilNoEnd date
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Get sales breakdown,' implying a read-only operation, but does not cover aspects like authentication needs, rate limits, error handling, or what the output format looks like (e.g., JSON structure, pagination). For a tool with zero annotation coverage, this is a significant gap in transparency.

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 a single, efficient sentence that directly states the tool's purpose with no wasted words. It is front-loaded and appropriately sized for its function, making it easy to understand at a glance.

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

Completeness3/5

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

Given the tool's complexity (a read operation with date parameters) and the absence of annotations and output schema, the description is minimally adequate. It explains what the tool does but lacks details on behavioral traits, output format, and usage context. With no output schema, the description should ideally hint at return values, but it doesn't, leaving gaps in completeness.

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?

The schema description coverage is 100%, with both parameters ('since' and 'until') well-documented in the schema. The description does not add any parameter-specific details beyond what the schema provides, such as explaining how sales channels are defined or if there are default date ranges. Given the high schema coverage, the baseline score of 3 is appropriate.

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?

The description clearly states the verb 'Get' and the resource 'sales breakdown by sales channel', with examples of channels like 'Online Store, POS, etc.' This specifies what the tool does. However, it does not explicitly differentiate from siblings like 'shopify_sales_summary' or 'shopify_sales_by_product', which might offer overlapping or alternative sales data, so it falls short of a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives. With siblings such as 'shopify_sales_summary' and 'shopify_sales_by_product', it's unclear if this tool is preferred for channel-specific insights or if there are prerequisites like date ranges. No explicit when/when-not or alternative tools are mentioned.

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

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