Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

churn_report

Read-only

Generates a Shopify app churn report for a date range, showing uninstall and subscription cancellation counts, reasons, scheduled cancellations, and lost shops with last plan and lifetime earnings.

Instructions

Uninstalls and subscription cancellations in the range: counts, uninstall reasons as Shopify reports them, scheduled cancellations, and each lost shop with its last plan and lifetime earnings, most valuable first. 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": "churn_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoEnd. Defaults to now: YYYY-MM-DD (UTC) or an ISO 8601 date-time
fromNoStart. Defaults to 90 days ago: YYYY-MM-DD (UTC) or an ISO 8601 date-time
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 only declare readOnlyHint and openWorldHint; the description adds substantive behavior the schema cannot convey: results are computed from the app's full downloaded event history and cached for 15 minutes, which tells the agent to expect stale-but-complete data and a first-call download cost. It also discloses result ordering ('most valuable first'). It does not discuss auth/permission specifics or pagination/limits on large result sets.

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 the returned content and followed by a second sentence that earns its place by explaining the caching/data-source behavior. The content list is dense but each item is a distinct field of the report; no filler.

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 carries the burden of describing returns, and it does so field-by-field (counts, reasons, scheduled cancellations, per-shop plan and lifetime earnings, sort order). Combined with the caching note, an agent could call this correctly. Minor gap: no guidance on result size or what an empty range yields.

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 from/to formats and the appId default behavior are already documented in the schema. The description adds only the loose phrase 'in the range' and 'the app,' attaching no new meaning to the parameters. Baseline 3 is correct.

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 enumerates exactly what the report contains: uninstall/cancellation counts, uninstall reasons as Shopify reports them, scheduled cancellations, and per-shop detail sorted by lifetime earnings. That is far more specific than the name alone. It stops short of a 5 because there is no explicit verb ('returns/generates') and no routing language distinguishing it from adjacent analytics siblings like mrr_movement or retention_cohorts.

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 implied: it is a range-scoped churn/uninstall report, so use it when analyzing lost shops over a period. There is no explicit when-to-use, no when-not conditions, and no named alternative for related questions (e.g. revenue loss over time vs. churn list).

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