Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

revenue_summary

Read-only

Summarize Shopify Partner revenue by calculating total net, gross, and Shopify fees per currency and transaction type for a specified date range.

Instructions

Total net, gross, and Shopify fees per currency, split by transaction type, for a time range. Reads up to 2,000 transactions.

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": "revenue_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
appIdNoApp ID: the number or a gid:// ID
typesNoTransactionType values, e.g. APP_SUBSCRIPTION_SALE
shopIdNoShop ID: the number or a gid:// ID
createdAtMaxNoLatest creation time, ISO 8601
createdAtMinNoEarliest creation time, ISO 8601
myshopifyDomainNoFor example example.myshopify.com

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already establish this as a read-only, open-world operation, so safety needs no restating. The description adds a genuinely important behavior beyond that: it 'reads up to 2,000 transactions', which warns the agent that results may be bounded by a row cap. It stops short of saying whether exceeding that cap truncates silently or affects the totals, which keeps it from a 5.

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?

Two short sentences, with the output shape front-loaded and the row limit immediately after. There is no filler and every clause carries information the agent can act on or reason about.

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?

With no output schema, the description must convey the return shape, and it does: net, gross and fee totals per currency, split by transaction type. For a six-parameter, all-optional filter tool that is largely sufficient; the only gap is what happens at the 2,000-transaction boundary and whether empty results are possible.

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 appId, shopId, types, and the ISO 8601 time bounds are already documented in the schema. The description only implies that the time-range parameters drive the aggregation and that transaction types are a grouping dimension, adding little meaning beyond the field-level docs. 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?

It names the measures (net, gross, Shopify fees), the grouping keys (per currency, by transaction type) and the scope (a time range), so the agent knows exactly what aggregate it returns. It does not distinguish itself from adjacent reporting siblings such as earnings_by_month, so it falls short of a 5.

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 contains no explicit when-to-use statement or named alternative, so the agent must infer that this is a revenue/fee aggregation over a window. The 'for a time range' framing and the row cap hint at the intended context, but nothing is stated about when to prefer list_transactions or another report.

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