Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

earnings_by_month

Read-only

Calculates your net, gross, and Shopify fees per month by currency and earning event type, plus upcoming settlements, from the app's full event history.

Instructions

What you actually earned per month: net, gross, and Shopify fee per currency, split by earning event type (recurring, usage, one-time, refund, credit, adjustment), plus upcoming settlements by date. Computed from the app's full event history, which the server downloads once and caches for 15 minutes.

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

Input Schema

NameRequiredDescriptionDefault
appIdNoApp ID: the number or a gid:// ID. Optional when SHOPIFY_PARTNER_APP_IDS names exactly one app
monthsNoHow many calendar months, ending with the current one

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Beyond readOnlyHint=true and openWorldHint=true, it discloses that results are computed from the app's full event history and that the server downloads once and caches for 15 minutes - genuinely useful latency and freshness context that annotations cannot convey. It omits other behavioral facts such as how upcoming settlements are bounded or what happens on cache expiry for a first call.

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?

Two sentences, front-loaded with what is returned before the implementation note. The long parenthetical list of event types is dense but earns its place since it defines the output breakdown. Slight run-on quality but no filler sentences.

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 no output schema and two optional parameters, the description covers the output dimensions, granularity (per month, per currency), and data provenance/caching. Missing only minor points such as whether months with no activity appear and how far ahead settlements are projected, which are not blocking for correct invocation.

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 both appId and months are already documented in the schema, and the description adds no format or interpretation detail beyond what is there. It does not clarify the month window semantics (e.g., that 'months' bounds the returned rows) relative to the per-month framing. 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?

Opens with a concrete framing - 'What you actually earned per month: net, gross, and Shopify fee per currency' - and enumerates the split dimensions (recurring, usage, one-time, refund, credit, adjustment) plus upcoming settlements. An agent can tell this is a realized-earnings breakdown, not an MRR or transaction-list tool. It stops short of naming a sibling such as revenue_summary or mrr_movement 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?

Usage is only implied: the 'actually earned' framing and 'upcoming settlements' hint at when this is the right call, but there is no explicit when-to-use, no prerequisites, and no statement of which alternative (e.g., revenue_summary, list_events) to pick instead. The agent must infer the selection rule.

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