Skip to main content
Glama
Sign In
Shopify MCP Server

Shopify MCP Server

by hamzashahbaz
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

shopify_sales_over_time

Analyze sales trends and performance metrics over time periods to identify patterns and make data-driven decisions for Shopify stores.

Instructions

Get sales metrics over time as a time series. Useful for trends and comparisons.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "shopify_sales_over_time"
  }
}

Input Schema

NameRequiredDescriptionDefault
sinceNoStart date. Examples: '-30d', '-3m', '-1y'
untilNoEnd date
intervalNoTime grouping interval (default: day)
compareNoIf true, includes year-over-year comparison
metricsNoComma-separated metrics to show. Default: total_sales, orders, average_order_value

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.3/5.0
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 mentions the tool is 'useful for trends and comparisons,' which hints at its analytical nature, but fails to disclose critical behaviors like whether it requires authentication, has rate limits, returns paginated results, or what happens with invalid inputs. For a data retrieval tool with zero annotation coverage, this is a significant gap.

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 highly concise and well-structured, consisting of two sentences that efficiently convey the core purpose and utility. Every sentence earns its place: the first states what the tool does, and the second adds context on its usefulness. There is no wasted verbiage or redundancy.

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 (5 parameters, no output schema, no annotations), the description is minimally adequate. It covers the basic purpose but lacks details on behavioral traits, output format, or error handling. Without annotations or an output schema, the agent might struggle with how to interpret results or handle edge cases, making this incomplete for robust usage.

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 description does not add any parameter-specific information beyond what the input schema provides. Since schema description coverage is 100%, the schema already documents all parameters (e.g., 'since', 'until', 'interval', 'compare', 'metrics') with descriptions and examples. The baseline score of 3 is appropriate as the schema does the heavy lifting, and the description doesn't compensate with additional semantics.

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 tool's purpose: 'Get sales metrics over time as a time series.' It specifies the verb ('Get'), resource ('sales metrics'), and output format ('time series'). However, it doesn't explicitly differentiate from siblings like 'shopify_sales_summary' or 'shopify_sales_by_product', which might offer similar sales data in different formats or scopes.

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 provides implied usage guidance with 'Useful for trends and comparisons,' suggesting when to use this tool. However, it lacks explicit alternatives or exclusions, such as when to choose this over 'shopify_sales_summary' for aggregated data or 'shopify_sales_by_product' for product-level details. No clear when-not-to-use scenarios are mentioned.

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

Deploy Server

Other Tools