Skip to main content
Glama

shopify_query

Read-only

Run a validated read-only Shopify Admin GraphQL query. Owners and admins only. Guide: shopify.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace": "<workspace>"
    },
    "name": "shopify_query"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
cursorNo
variablesNo
workspaceYes
include_piiNo
shopify_connectionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds that queries are 'validated' and restricted to owners/admins, but does not explain what 'validated' means, rate limits, pagination behavior, or how the open-world nature affects results.

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

Conciseness4/5

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

The description is three short sentences and front-loads the core action. It is efficiently sized, though 'Guide: shopify.' is a low-value pointer and 'validated' is vague enough that the sentence could carry more meaning.

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

Completeness2/5

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

This is a complex tool: six parameters, a nested oneOf for shopify_connection, no output schema, and no parameter descriptions. The description omits critical context about connection variants, include_pii behavior, cursor pagination, and what a GraphQL response looks like, making it incomplete for correct invocation.

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% across six parameters, so the description must compensate and largely does not. The phrase 'GraphQL query' loosely implies the query and variables parameters, but workspace, cursor, include_pii, and the shopify_connection oneOf variants are left completely unexplained.

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?

States a specific verb and resource: running a validated read-only Shopify Admin GraphQL query. It is clear what the tool does and that it is scoped to Shopify's Admin GraphQL API, but it does not explicitly distinguish itself from sibling tools like shopify_get or commerce_api.

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 only usage guidance is a permission prerequisite ('Owners and admins only') and a pointer to a guide ('Guide: shopify'). It does not say when to use this GraphQL tool versus shopify_get, commerce_api, or other Shopify-related siblings, nor does it list exclusions or alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources