Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

plan_performance

Read-only

Analyze each Shopify plan's current paying and trialing shops, MRR, and date-range subscription changes, cancellations, and plan moves from cached app event history.

Instructions

Per plan handle: paying and trialing shops now, MRR now, and in the range new subscriptions, cancellations, and moves in and out of the plan. 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": "plan_performance"
  }
}

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.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds genuinely non-obvious behavioral context beyond that: results are computed from the app's full event history, which the server downloads once and caches for 15 minutes — implying possible staleness and first-call latency. It stops short of describing pagination, per-plan ordering, or what happens for plans with no events in range.

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 sentences, zero filler, and the returned-content inventory is front-loaded before the computational caveat. The colon-scoped fragment style is dense but readable, and every clause (metric list, 'now' vs 'in the range', caching) carries real 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 carries the burden of explaining return values, and it does so by enumerating the metric groups and separating current-state from in-range deltas. Combined with full schema coverage on the three optional parameters and the caching note, an agent has what it needs to call this correctly; only the shape of the response (object per plan handle vs list) is left implicit.

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/appId formats, defaults, and the env-var fallback are already fully documented in the schema. The description only indirectly reinforces range semantics via 'in the range new subscriptions, cancellations, and moves' — notably clarifying that the movement metrics are scoped to the range while shops/MRR are 'now'. That nuance is useful but modest given the schema does the rest.

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 precisely ('per plan handle') and enumerates the exact metrics returned: paying/trialing shops, MRR, new subscriptions, cancellations, and plan moves. It is clear enough to distinguish the tool from generic siblings like revenue_summary or app_overview, but it uses a sentence fragment with no verb and never explicitly contrasts itself with the closely related mrr_movement or churn_report.

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 metric list suggests this is the right tool for a per-plan breakdown of current state plus in-range movement. There is no explicit 'use this when...' clause, no exclusion, and no pointer to alternatives such as mrr_movement for movement-only reporting. An agent can infer the fit, but must reason about it.

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