vendure-mcp-graphql 1.1.1 → 1.2.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 +32 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# vendure-mcp-graphql
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/vendure-mcp-graphql) [](https://www.npmjs.com/package/vendure-mcp-graphql)
|
|
4
|
+
|
|
3
5
|
MCP (Model Context Protocol) server for interacting with Vendure GraphQL APIs (Admin & Shop).
|
|
4
6
|
|
|
5
7
|
## Installation
|
|
@@ -20,7 +22,7 @@ Configure as an MCP server in your IDE (like Claude Desktop):
|
|
|
20
22
|
"args": [],
|
|
21
23
|
"env": {
|
|
22
24
|
"VENDURE_URL": "http://localhost:3000/admin-api",
|
|
23
|
-
"
|
|
25
|
+
"VENDURE_API_KEY": "your-key-here"
|
|
24
26
|
}
|
|
25
27
|
}
|
|
26
28
|
}
|
|
@@ -30,28 +32,31 @@ Configure as an MCP server in your IDE (like Claude Desktop):
|
|
|
30
32
|
## Tools
|
|
31
33
|
|
|
32
34
|
### Admin API
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `
|
|
35
|
+
|
|
36
|
+
| Tool | Description |
|
|
37
|
+
| ----------------------- | -------------------------------------------------------- |
|
|
38
|
+
| `admin_query` | Execute a GraphQL query on the Admin API |
|
|
39
|
+
| `admin_mutation` | Execute a GraphQL mutation on the Admin API |
|
|
40
|
+
| `admin_batch_mutation` | Execute a mutation in bulk for multiple IDs (concurrent) |
|
|
41
|
+
| `get_admin_schema` | Fetch the full Admin API schema introspection |
|
|
42
|
+
| `list_admin_operations` | List all available Admin API queries and mutations |
|
|
40
43
|
|
|
41
44
|
### Shop API
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
45
|
+
|
|
46
|
+
| Tool | Description |
|
|
47
|
+
| ---------------------- | -------------------------------------------------------- |
|
|
48
|
+
| `shop_query` | Execute a GraphQL query on the Shop API |
|
|
49
|
+
| `shop_mutation` | Execute a GraphQL mutation on the Shop API |
|
|
50
|
+
| `shop_batch_mutation` | Execute a mutation in bulk for multiple IDs (concurrent) |
|
|
51
|
+
| `get_shop_schema` | Fetch the full Shop API schema introspection |
|
|
52
|
+
| `list_shop_operations` | List all available Shop API queries and mutations |
|
|
49
53
|
|
|
50
54
|
### Batch Mutations
|
|
51
55
|
|
|
52
56
|
The batch mutation tools allow you to run a single mutation across multiple IDs concurrently. Useful for bulk operations like deleting or updating many records at once.
|
|
53
57
|
|
|
54
58
|
**Parameters:**
|
|
59
|
+
|
|
55
60
|
- `mutation` (required) — GraphQL mutation string with an ID variable (e.g. `$id: ID!`)
|
|
56
61
|
- `ids` (required) — Array of IDs to run the mutation for
|
|
57
62
|
- `variableName` — Name of the ID variable in the mutation (default: `"id"`)
|
|
@@ -59,6 +64,7 @@ The batch mutation tools allow you to run a single mutation across multiple IDs
|
|
|
59
64
|
- `concurrency` — Max concurrent mutations (default: `5`)
|
|
60
65
|
|
|
61
66
|
**Example — bulk delete products:**
|
|
67
|
+
|
|
62
68
|
```json
|
|
63
69
|
{
|
|
64
70
|
"mutation": "mutation DeleteProduct($id: ID!) { deleteProduct(id: $id) { result } }",
|
|
@@ -68,14 +74,23 @@ The batch mutation tools allow you to run a single mutation across multiple IDs
|
|
|
68
74
|
```
|
|
69
75
|
|
|
70
76
|
**Returns per-ID results:**
|
|
77
|
+
|
|
71
78
|
```json
|
|
72
79
|
{
|
|
73
80
|
"total": 3,
|
|
74
81
|
"succeeded": 2,
|
|
75
82
|
"failed": 1,
|
|
76
83
|
"results": [
|
|
77
|
-
{
|
|
78
|
-
|
|
84
|
+
{
|
|
85
|
+
"id": "1",
|
|
86
|
+
"success": true,
|
|
87
|
+
"data": { "deleteProduct": { "result": "DELETED" } }
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"id": "2",
|
|
91
|
+
"success": true,
|
|
92
|
+
"data": { "deleteProduct": { "result": "DELETED" } }
|
|
93
|
+
},
|
|
79
94
|
{ "id": "3", "success": false, "error": "Product not found" }
|
|
80
95
|
]
|
|
81
96
|
}
|