How do I install Shopify Partner Agent?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Shopify Partner Agent need an API key?

No required environment variable is listed on this record.

What transport does Shopify Partner Agent use?

Shopify Partner Agent runs locally over stdio.

When was Shopify Partner Agent last checked?

Last checked 2026-10-27. MCP server for Shopify Partner API analytics - 25 tools for MRR, churn, retention, merchant health, forecasting. Free and open source.

Shopify Partner Agent MCP 服务器

Shopify Partner Agent

Free, open-source MCP server that connects Claude to the Shopify Partner API. 25 tools for revenue analytics, churn analysis, retention cohorts, merchant health scoring, conversion funnels, revenue forecasting, and growth velocity.

Query your app business in natural language. No dashboards, no monthly fees.

Why This Exists

Shopify's own AI Toolkit and official MCP servers (Dev MCP, Storefront MCP, Customer Account MCP, Checkout MCP) all target the Admin API and Storefront API, which cover store operations and shopping experiences. Every third-party Shopify MCP server on GitHub does the same.

None of them connect to the Partner API. If you build Shopify apps, your revenue metrics, churn data, and merchant analytics are locked behind the Partner Dashboard with no MCP-compatible way to query them.

Shopify Partner Agent is the only MCP server that gives AI tools access to Partner API analytics: MRR, churn, retention cohorts, merchant health, and 20 more computed metrics that even the raw API doesn't provide.

Ask Claude things like:

"What's my MRR and how has it changed this quarter?"
"Who uninstalled my app this month and why?"
"Show me retention cohorts for the last 6 months"
"Which merchants are at high risk of churning?"
"Give me a weekly business digest"
"Compare all my apps side by side"

Tools

Core Data (5)

Tool	What it does
`discover_apps`	Find all apps in your partner account (from config + transaction history)
`get_app_details`	App name, GID, and API key for a specific app
`get_app_events`	Install, uninstall, charge, credit events with date filtering
`get_transactions`	Revenue transactions filtered by app, type, and date range
`get_merchants`	Active, churned, or all merchants with install dates and uninstall reasons

Revenue Analytics (4)

Tool	What it does
`get_revenue_summary`	MRR, ARR, total revenue, growth rate, ARPU, breakdown by app and currency
`get_mrr_movement`	New, expansion, contraction, churn, and reactivation MRR breakdown
`get_payout_report`	Gross revenue, Shopify fees, net payout with per-type breakdown
`get_plan_performance`	Subscribers, revenue, and avg revenue per pricing tier

Customer Analytics (4)

Tool	What it does
`get_churn_analysis`	Revenue churn %, logo churn %, uninstall reason breakdown
`get_retention_cohorts`	Monthly revenue retention cohort table (values above 100% = expansion)
`get_customer_ltv`	LTV, ARPU, average lifespan, top and bottom 5 merchants by revenue
`get_churned_merchants`	Recent uninstalls with dates and reasons, sorted most recent first

Growth & Forecasting (6)

Tool	What it does
`get_trial_funnel`	Install-to-paid conversion rate, timing analysis, converted/unconverted lists
`get_growth_velocity`	Week-over-week install/uninstall/revenue trends with acceleration signals
`get_install_patterns`	Best day of week and time of month for installs, monthly trend
`get_revenue_forecast`	Project MRR for next 3-6 months based on historical growth rate
`get_referral_revenue`	Shopify merchant referral revenue with period comparison
`get_credits_adjustments`	Refunds, credits, adjustments with giveback percentage

Merchant Intelligence (4)

Tool	What it does
`get_churn_risk`	Score active merchants by churn risk (low/medium/high) with contributing factors
`get_merchant_health`	Composite health grade (A-F) based on tenure, revenue, stability, engagement
`get_merchant_lookup`	Full chronological timeline for a specific merchant (events + transactions)
`get_business_digest`	Weekly or monthly summary with highlights and period-over-period comparison

Multi-App (2)

Tool	What it does
`get_revenue_anomalies`	Detect unusual revenue patterns using statistical deviation
`get_app_comparison`	Side-by-side metrics (revenue, installs, churn, ARPU) across all apps

Install

Before you start, you need:

A Shopify Partner account.
An MCP client installed: Claude Desktop, Claude Code, Cursor, or Windsurf. Claude Desktop is free and takes two minutes to install if you don't have one yet.

1. Get your Partner API credentials

You need three values. Log in to the Partners Dashboard first, then collect each one below.

SHOPIFY_ORG_ID

The number in your Dashboard URL. Once you are logged in, look at the address bar:

https://partners.shopify.com/1234567/...
                             ^^^^^^^  this is your org ID

SHOPIFY_ACCESS_TOKEN

Open Settings > Partner API clients in the Dashboard.
Click Create API client.
Grant permissions: Manage apps and View financials.
Copy the token. It is shown only once, so save it somewhere safe.

SHOPIFY_APP_IDS

One entry per app you want to query, comma-separated.

Open Apps in the Dashboard and click an app.
The URL ends with a numeric ID, for example /apps/9876543.
Format it as a GID: gid://partners/App/9876543. Bare numeric IDs also work.
Multiple apps? Join them with commas: gid://partners/App/1,gid://partners/App/2.

2. Add the server to your MCP client

Your MCP client will install and run the server automatically the first time it launches. You don't need to download, clone, or set up anything yourself.

The config you paste below tells your MCP client to run a command called uvx. On first launch, uvx fetches the server from the Python package registry (PyPI) and stores it in a local folder on your computer. After that, startup is instant.

Where the files sit:

macOS / Linux: ~/.cache/uv/
Windows: %LOCALAPPDATA%\uv\cache\

The installed package contains only the server code. It does not include your credentials, any test files, or anything else from your machine. The source is public on PyPI and GitHub, so you can audit exactly what runs.

Remove the installed copy later:

uv cache clean shopify-partner-agent

Update to the latest release: run the command above, then restart your MCP client. It fetches the newest version on the next launch.

Prefer a traditional install you can see on disk? Use the pip install option further down, or git clone the repo and run uv sync.

Claude Desktop is the most common path. Paste the block below into claude_desktop_config.json and swap in the three values from step 1:

{
  "mcpServers": {
    "shopify-partner-agent": {
      "command": "uvx",
      "args": ["shopify-partner-agent"],
      "env": {
        "SHOPIFY_ORG_ID": "your_org_id",
        "SHOPIFY_ACCESS_TOKEN": "your_token",
        "SHOPIFY_APP_IDS": "gid://partners/App/1234567"
      }
    }
  }
}

Config file location:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

If the file does not exist yet, create it with the block above exactly as shown. If it already contains other MCP servers, add shopify-partner-agent inside the existing mcpServers object.

Using a different client? Open the matching section below.

One command from your terminal:

claude mcp add shopify-partner-agent uvx shopify-partner-agent \
  -e SHOPIFY_ORG_ID=your_org_id \
  -e SHOPIFY_ACCESS_TOKEN=your_token \
  -e SHOPIFY_APP_IDS=gid://partners/App/1234567

Same JSON as Claude Desktop. Open the MCP settings panel and paste the block below.

Cursor: Settings > MCP > Add new global MCP server, or edit ~/.cursor/mcp.json directly.
Windsurf: Settings > Cascade > MCP servers.

{
  "mcpServers": {
    "shopify-partner-agent": {
      "command": "uvx",
      "args": ["shopify-partner-agent"],
      "env": {
        "SHOPIFY_ORG_ID": "your_org_id",
        "SHOPIFY_ACCESS_TOKEN": "your_token",
        "SHOPIFY_APP_IDS": "gid://partners/App/1234567"
      }
    }
  }
}

pip install shopify-partner-agent

Then update your MCP config to call the installed command directly instead of uvx:

{
  "mcpServers": {
    "shopify-partner-agent": {
      "command": "shopify-partner-agent",
      "env": {
        "SHOPIFY_ORG_ID": "your_org_id",
        "SHOPIFY_ACCESS_TOKEN": "your_token",
        "SHOPIFY_APP_IDS": "gid://partners/App/1234567"
      }
    }
  }
}

Open any LLM chat and paste the prompt below. It asks which client you use and generates the exact config file path and JSON for you.

I want to install the shopify-partner-agent MCP server. It is a Python package on PyPI that connects AI assistants to the Shopify Partner API for revenue, churn, cohort, and merchant analytics.

Walk me through setup step by step:

1. Ask which MCP client I use: Claude Desktop, Claude Code, Cursor, or Windsurf.
2. Explain how to create a Shopify Partner API access token: Partners Dashboard > Settings > Partner API clients > Create API client. Required scopes: "Manage apps" and "View financials". The token is shown only once, so I need to copy it.
3. Explain how to find my app GIDs. The format is gid://partners/App/1234567 and the numeric ID is visible in the Partners Dashboard URL when I open an app.
4. Generate the MCP config for the client I picked. Use the command "uvx" with args ["shopify-partner-agent"] and these placeholder env vars: SHOPIFY_ORG_ID=<my_org_id>, SHOPIFY_ACCESS_TOKEN=<my_token>, SHOPIFY_APP_IDS=<comma_separated_app_gids>.
5. Tell me the exact config file path for my client on macOS and Windows, and where in that file the mcpServers section goes.
6. Tell me to replace the placeholders on my own machine. Do NOT ask me to paste my real token into this chat.
7. Tell me to fully quit and relaunch the MCP client, then confirm the 25 shopify-partner-agent tools appear.

Reference: https://github.com/rushikeshmore/shopify-partner-agent
Package:   https://pypi.org/project/shopify-partner-agent/

Keep your access token out of chat. Generate the config with placeholders, then fill in the real token locally.

3. Restart your MCP client and verify

Save the config, then fully quit and relaunch your MCP client. Most clients only read config at startup, so a window reload will not pick it up. After the client restarts, look for shopify-partner-agent in the tools or MCP menu. It should appear as connected with 25 tools. If something is off, see Troubleshooting.

4. Start using it

> Show me my Shopify apps
> What's my churn rate this month?
> Who uninstalled recently and why?
> Give me a full health check of my app business
> Score my merchants by churn risk

missing required env vars: SHOPIFY_ORG_ID, ... Credentials aren't reaching the server. Double-check the env block in your MCP client config above, then fully restart the client.

401 Unauthorized or token errors The access token is wrong or missing scopes. Recreate it in Partners Dashboard with Manage apps + View financials and update your config.

App ID format errors App IDs must be GIDs: gid://partners/App/1234567. Bare numeric IDs won't work. Copy the correct format from the Partners Dashboard URL when you open the app.

Tools don't show up in Claude Desktop, Cursor, or Windsurf Fully quit and relaunch the MCP client after editing config. Most clients only read config at startup.

uvx is stuck on an old version after a release Clear the cache and retry: uv cache clean shopify-partner-agent.

Analytics Formulas

All formulas match industry-standard SaaS metrics:

Metric	Formula
MRR	Event-aware: subscription + usage MRR per active merchant (annual / 12, usage trailing 30d). Two-track status model: relationship (installed/uninstalled) + subscription (frozen/canceled/expired). Falls back to charge-based when events unavailable.
Net New MRR	New + Reactivation + Expansion - Contraction - Churn
Quick Ratio	(New + Expansion + Reactivation) / (Contraction + Churn)
Reactivation MRR	Revenue from previously-churned merchants who reinstalled
Revenue Churn %	(Churned MRR + Contraction) / Starting MRR x 100
Logo Churn %	Uninstalled merchants / Starting merchants x 100
LTV	ARPU x Average lifespan
ARPU	Total net revenue / Active merchants (excludes churned when events available)
Retention	Revenue in month N / Revenue in month 0 (per cohort)
Health Score	Tenure (0-25) + Revenue (0-25) + Stability (0-25) + Engagement (0-25)
Churn Risk	5 heuristic signals: deactivations, cancellations, reinstalls, declining charges, inactivity
Growth Velocity	Week-over-week install/revenue trends, revenue grouped by currency

Requirements

Python 3.11+
Shopify Partner account with API access
Any MCP-compatible client (Claude Code, Claude Desktop, Cursor, Windsurf)

Data Privacy

Direct API access. All Partner API calls go from your machine to Shopify. No proxy, no intermediate server, no cloud component operated by this project.
No telemetry. This server does not send usage, analytics, or error data anywhere. If you block every network except partners.shopify.com, it still works.
Credentials stay local. Your access token lives in your MCP client config (or .env if running from source). It never leaves your machine except to authenticate with Shopify.
Query results flow to your LLM. Tool responses return to your MCP client and are passed to whichever LLM provider you've configured (Anthropic, OpenAI, etc.), so the data you query becomes visible to that provider under their terms. This is inherent to how MCP works, not specific to this server.
Open source, MIT-licensed. Auditable at src/shopify_partner_agent/.

License

MIT. See LICENSE.

Shopify Partner Agent

添加此服务器

用我们的密钥与日志托管一份副本。

Server facts

Tools

Questions

How do I install Shopify Partner Agent?

Does Shopify Partner Agent need an API key?

What transport does Shopify Partner Agent use?

When was Shopify Partner Agent last checked?

Documentation

Shopify Partner Agent

Why This Exists

Tools

Core Data (5)

Revenue Analytics (4)

Customer Analytics (4)

Growth & Forecasting (6)

Merchant Intelligence (4)

Multi-App (2)

Install

1. Get your Partner API credentials

2. Add the server to your MCP client

3. Restart your MCP client and verify

4. Start using it

Analytics Formulas

Requirements

Data Privacy

License