Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

shop_history

Read-only

Retrieves one shop’s install and billing events plus earnings transactions for a single app, newest first, using a shop ID or domain to answer support questions.

Instructions

Everything about one shop for one app, newest first: install and billing events plus earnings transactions. Takes a shop ID or its myshopify.com domain. Useful for support questions.

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": {
      "shop": "<shop>"
    },
    "name": "shop_history"
  }
}

Input Schema

NameRequiredDescriptionDefault
shopYesShop ID, shop GID, or example.myshopify.com
appIdNoApp ID: the number or a gid:// ID. Optional when SHOPIFY_PARTNER_APP_IDS names exactly one app
occurredAtMaxNoEnd of the window. Defaults to now; the window is at most 365 days
occurredAtMinNoStart of the window. Defaults to 30 days before the end

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered. The description adds a real behavioral trait beyond them, the newest-first ordering and the merged event/transaction content, but says nothing about result volume, pagination, or what the returned records look like despite having no output schema.

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?

Three short sentences, front-loaded with what the tool returns and its ordering, followed by identifier forms and a use case. No filler or redundancy.

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?

For a read-only aggregation tool with a fully documented four-parameter schema and no output schema, the description covers content, ordering, and input forms adequately. The missing piece is any indication of result size or pagination for what could be a large multi-event history.

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?

Schema description coverage is 100%, so the schema already documents shop identifiers, appId (including the SHOPIFY_PARTNER_APP_IDS fallback), and the 365-day window defaults. The description restates only the accepted shop identifier forms and adds no syntax or format detail beyond the schema, so the baseline 3 applies.

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 states a specific resource and scope: a per-shop, per-app chronological history combining install events, billing events, and earnings transactions. That composition lets an agent distinguish it from the narrower siblings like list_events and list_transactions, though no sibling is named explicitly.

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?

"Useful for support questions" gives only a loose situational hint; there is no statement of when to prefer this aggregated history over list_events or list_transactions, nor any exclusion or prerequisite. Usage is implied rather than prescribed.

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