Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

customer_ltv

Read-only

Compute lifetime net earnings per paying Shopify shop—total, average, median, top-ten share by currency, median paying days, and top-earning shops—from cached app event history.

Instructions

Lifetime net earnings per paying shop: total, average, median, and top-ten share per currency, median paying days, and the ten highest-earning shops. 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": "customer_ltv"
  }
}

Input Schema

NameRequiredDescriptionDefault
appIdNoApp ID: the number or a gid:// ID. Optional when SHOPIFY_PARTNER_APP_IDS names exactly one app

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?

Annotations already cover readOnly and open-world, so the marginal bar is context — and the description delivers real behavior: the figures are computed from the app's full event history, and the server downloads that history once and caches it for 15 minutes. That tells the agent to expect a slow first call and possible staleness up to 15 minutes. It does not state cost, pagination, or what happens if the history is empty.

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, zero filler, and the metric inventory is front-loaded before the caching caveat. The long metric list is justified because there is no output schema to document the return shape. Slightly dense but every clause carries information.

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 correctly enumerates the returned metrics and their currency grouping, plus the data-source and cache-freshness context. Combined with a fully documented single optional parameter and read-only annotations, an agent has enough to invoke it correctly; only edge-case behavior (empty history, partial currency coverage) is unaddressed.

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?

There is a single optional appId parameter with 100% schema description coverage, including the SHOPIFY_PARTNER_APP_IDS fallback rule. The description adds nothing about appId, but the schema already carries the full meaning, so the baseline of 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 names the resource and scope precisely: lifetime net earnings per paying shop, with the exact metric set (total, average, median, top-ten share per currency, median paying days, top ten shops). That scope ('lifetime', 'per paying shop') implicitly separates it from siblings like earnings_by_month and revenue_summary. It stops short of a clean verb phrase and never names an alternative, so it is clear but not maximally differentiated.

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 by the scope words 'lifetime' and 'per paying shop' — an agent can infer this is the cohort-level LTV report rather than a time-series or transaction listing. There is no explicit when-to-use, when-not-to-use, or named alternative among the many siblings (revenue_summary, mrr_movement, earnings_by_month).

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