shopify-admin-readonly-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -0
- package/dist/index.js +50939 -0
- package/package.json +49 -0
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Shopify Admin Readonly MCP Server
|
|
2
|
+
|
|
3
|
+
A read-only MCP (Model Context Protocol) server for the Shopify Admin GraphQL API. Allows AI assistants to query your Shopify store data without any risk of modification.
|
|
4
|
+
|
|
5
|
+
## Tools Available
|
|
6
|
+
|
|
7
|
+
| Tool | Description |
|
|
8
|
+
|------|-------------|
|
|
9
|
+
| `shopify_get_shop` | Get store info (name, domain, currency, plan) |
|
|
10
|
+
| `shopify_list_products` | List products with filtering and pagination |
|
|
11
|
+
| `shopify_get_product` | Get full product details including variants and images |
|
|
12
|
+
| `shopify_list_product_variants` | List variants with SKU/inventory filtering |
|
|
13
|
+
| `shopify_list_orders` | List orders with status filtering |
|
|
14
|
+
| `shopify_get_order` | Get full order details with fulfillments |
|
|
15
|
+
| `shopify_list_customers` | Search/list customers |
|
|
16
|
+
| `shopify_get_customer` | Get full customer details with order history |
|
|
17
|
+
| `shopify_list_collections` | List product collections |
|
|
18
|
+
| `shopify_list_locations` | List fulfillment locations |
|
|
19
|
+
| `shopify_get_inventory_levels` | Get inventory by location |
|
|
20
|
+
|
|
21
|
+
## Setup
|
|
22
|
+
|
|
23
|
+
### 1. Get Shopify Credentials
|
|
24
|
+
|
|
25
|
+
1. In your Shopify admin, go to **Settings → Apps and sales channels → Develop apps**
|
|
26
|
+
2. Create a new app (or use an existing one)
|
|
27
|
+
3. Under **Configuration → Admin API scopes**, add these read-only scopes:
|
|
28
|
+
- `read_products`
|
|
29
|
+
- `read_orders`
|
|
30
|
+
- `read_customers`
|
|
31
|
+
- `read_inventory`
|
|
32
|
+
- `read_locations`
|
|
33
|
+
4. Install the app and copy the **Admin API access token**
|
|
34
|
+
|
|
35
|
+
### 2. Install & Build
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install
|
|
39
|
+
npm run build
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 3. Configure Claude Desktop (stdio)
|
|
43
|
+
|
|
44
|
+
Add to your `claude_desktop_config.json`:
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"mcpServers": {
|
|
49
|
+
"shopify-readonly": {
|
|
50
|
+
"command": "node",
|
|
51
|
+
"args": ["/path/to/shopify-admin-readonly-mcp/dist/index.js"],
|
|
52
|
+
"env": {
|
|
53
|
+
"SHOPIFY_SHOP_DOMAIN": "your-store.myshopify.com",
|
|
54
|
+
"SHOPIFY_ACCESS_TOKEN": "shpat_xxxxxxxxxxxx"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 4. Run as HTTP Server
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
TRANSPORT=http SHOPIFY_SHOP_DOMAIN=your-store.myshopify.com SHOPIFY_ACCESS_TOKEN=shpat_xxx PORT=3000 node dist/index.js
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Environment Variables
|
|
68
|
+
|
|
69
|
+
| Variable | Required | Description |
|
|
70
|
+
|----------|----------|-------------|
|
|
71
|
+
| `SHOPIFY_SHOP_DOMAIN` | ✅ | Your store domain (e.g., `my-store.myshopify.com`) |
|
|
72
|
+
| `SHOPIFY_ACCESS_TOKEN` | ✅ (legacy) | Static token from admin-created custom app (`shpat_...`) |
|
|
73
|
+
| `SHOPIFY_CLIENT_ID` | ✅ (Dev Dashboard) | Client ID from Dev Dashboard app |
|
|
74
|
+
| `SHOPIFY_CLIENT_SECRET` | ✅ (Dev Dashboard) | Client Secret from Dev Dashboard app |
|
|
75
|
+
| `SHOPIFY_API_VERSION` | Optional | API version (default: `2025-01`) |
|
|
76
|
+
| `TRANSPORT` | Optional | `stdio` (default) or `http` |
|
|
77
|
+
| `PORT` | Optional | HTTP port (default: `3000`) |
|
|
78
|
+
|
|
79
|
+
> **Auth modes:** Use either `SHOPIFY_ACCESS_TOKEN` (legacy custom apps) **or** the pair `SHOPIFY_CLIENT_ID` + `SHOPIFY_CLIENT_SECRET` (Dev Dashboard apps). Tokens for Dev Dashboard apps expire every 24 hours and are automatically refreshed by the server.
|
|
80
|
+
|
|
81
|
+
## Security
|
|
82
|
+
|
|
83
|
+
This server is **strictly read-only** — it only uses GraphQL queries, never mutations. All tools have `readOnlyHint: true` and `destructiveHint: false` annotations.
|