Skip to main content
Glama
shopify-partners-mcp

shopify-partners-mcp

by amitray007

app_overview

Read-only

Get each app's current status (installed, paying, trialing, frozen, MRR, ARR) and what changed in the last 30 days. Compares all apps when no appId is given.

Instructions

Start here. Where an app stands now (installed, paying, trialing, frozen, MRR, ARR) and what moved in the last 30 days. Without appId, compares every app in SHOPIFY_PARTNER_APP_IDS. 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": "app_overview"
  }
}

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

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

Annotations already cover safety (readOnlyHint) and scope (openWorldHint), so the description earns credit for the extra operational detail: the result is computed from full event history, and the server downloads that history once and caches it for 15 minutes. That caching note is real behavioral context an agent would not otherwise have. It stops short of describing response shape or cost of the first uncached 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?

Three short sentences with the call to action ('Start here') front-loaded and the fallback behavior and caching note in descending order of importance. The parenthetical metric list is dense but justified since there is no output schema. 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?

With no output schema, the description carries the return-value burden, and it does so by enumerating the states and metrics reported plus the 30-day movement window. Combined with the cache caveat and the no-appId behavior, an agent has enough to call it correctly; only pagination/response format details are absent, and those are minor here.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter is fully described in the schema (100% coverage), so the baseline is 3. The description adds meaning beyond it by stating what omitting appId actually does — compares every app listed in SHOPIFY_PARTNER_APP_IDS — which tells the agent the practical consequence of the optional argument.

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?

"Start here. Where an app stands now (installed, paying, trialing, frozen, MRR, ARR) and what moved in the last 30 days" names the resource (app state) and the exact metrics returned, which is far more specific than the vague name app_overview. It does not name a sibling to contrast with, relying instead on "Start here" to imply primacy.

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?

"Start here" gives a clear entry-point recommendation, and the no-appId branch explains the multi-app comparison mode. There is no explicit when-not guidance and no named alternative for drilling into a single metric (e.g. mrr_movement or revenue_summary), so selection among siblings is left implied.

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