Skip to content

Commit 2a2bc7e

Browse files
tizmagikclaude
andcommitted
Add README for @shopify/mcp package
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 92d5a6d commit 2a2bc7e

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

packages/mcp/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# @shopify/mcp
2+
3+
MCP server for the Shopify Admin API. Connects AI coding agents (Claude, Cursor, etc.) to your Shopify store via the [Model Context Protocol](https://modelcontextprotocol.io).
4+
5+
## Setup
6+
7+
```bash
8+
claude mcp add shopify -- npx -y -p @shopify/mcp
9+
```
10+
11+
Optionally set a default store so you don't have to pass it with every request:
12+
13+
```bash
14+
export SHOPIFY_FLAG_STORE=my-store.myshopify.com
15+
```
16+
17+
## Tools
18+
19+
### `shopify_auth_login`
20+
21+
Authenticate with a Shopify store. Returns a URL the user must visit to complete login via device auth. After approval, subsequent `shopify_graphql` calls will use the session automatically.
22+
23+
| Parameter | Type | Required | Description |
24+
|-----------|------|----------|-------------|
25+
| `store` | string | No | Store domain. Defaults to `SHOPIFY_FLAG_STORE` env var. |
26+
27+
### `shopify_graphql`
28+
29+
Execute a GraphQL query or mutation against the Shopify Admin API. Uses the latest supported API version.
30+
31+
| Parameter | Type | Required | Description |
32+
|-----------|------|----------|-------------|
33+
| `query` | string | Yes | GraphQL query or mutation string |
34+
| `variables` | object | No | GraphQL variables |
35+
| `store` | string | No | Store domain override. Defaults to `SHOPIFY_FLAG_STORE` env var. |
36+
| `allowMutations` | boolean | No | Must be `true` to execute mutations. Safety measure to prevent unintended changes. |
37+
38+
## Example
39+
40+
```
41+
Agent: "List my products"
42+
43+
→ shopify_auth_login(store: "my-store.myshopify.com")
44+
← "Open this URL to authenticate: https://accounts.shopify.com/activate?user_code=ABCD-EFGH"
45+
46+
[user approves in browser]
47+
48+
→ shopify_graphql(query: "{ products(first: 5) { edges { node { title } } } }")
49+
← { "products": { "edges": [{ "node": { "title": "T-Shirt" } }, ...] } }
50+
```

0 commit comments

Comments
 (0)