Skip to main content
Glama

shopify_run_analytics_query

Read-onlyIdempotent

Execute ShopifyQL analytics queries to retrieve columns, rows, and chart metadata from Shopify stores with report access.

Instructions

Run ShopifyQL and return columns, rows and chart metadata. Requires reports access.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
storeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.6.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, so the description does not need to restate safety. It adds useful behavioral context by noting the reports access requirement and the return shape (columns, rows, chart metadata). No contradiction with annotations is present.

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 front-loads the action, names the query language, specifies the return content, and includes the key access requirement. Every part earns its place with no filler.

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?

For a two-parameter read-only tool, the description gives a reasonable overview and return format, and annotations cover safety. However, the lack of parameter details, no output schema, and no guidance on store naming or ShopifyQL syntax leave meaningful gaps for an agent trying to call the tool correctly.

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%, so the description carries the burden for explaining parameters. It indicates that 'query' is ShopifyQL, but it does not explain the 'store' parameter, expected formats, or any additional semantics. The description only partially compensates for the lack of 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 states a specific verb and resource: 'Run ShopifyQL and return columns, rows and chart metadata.' This clearly identifies the tool's purpose and distinguishes it from siblings like shopify_graphql_query or shopify_graphql_mutation.

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 implies usage for ShopifyQL analytics queries and adds a prerequisite ('Requires reports access'), but it does not explicitly explain when to choose this tool over alternatives or when not to use it. The usage context is clear enough to infer, but no exclusions or alternative routing are provided.

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