mcp-erp 1.0.6
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 +107 -0
- package/docs.md +1425 -0
- package/index.js +70 -0
- package/package.json +40 -0
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# mcp-erp
|
|
2
|
+
|
|
3
|
+
MCP (Model Context Protocol) server that provides GraphQL Storefront query documentation for the ERSPO Shopify CMS. Useful for AI assistants (Cursor, Claude, etc.) so they can access query documentation and sample responses without opening files manually.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## MCP Configuration
|
|
8
|
+
|
|
9
|
+
### From npm (recommended) — use `npx`
|
|
10
|
+
|
|
11
|
+
- **Package:** [mcp-erps](https://www.npmjs.com/package/mcp-erps)
|
|
12
|
+
- No clone needed. Ensure Node.js is installed, then add the config below to your MCP settings.
|
|
13
|
+
- A ready-to-use config file is in this repo: **`mcp-config.json`** (copy its contents or merge into your Cursor/Claude MCP config).
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"mcpServers": {
|
|
18
|
+
"mcp-erp": {
|
|
19
|
+
"command": "npx",
|
|
20
|
+
"args": ["-y", "mcp-erps"]
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
- `-y` skips the “Do you want to install?” prompt when the package is not cached.
|
|
27
|
+
- Install once (optional): `npm i -g mcp-erps` — then you can use `"args": ["-y", "mcp-erps"]` or run from PATH.
|
|
28
|
+
|
|
29
|
+
### Cursor
|
|
30
|
+
|
|
31
|
+
- **Location:** Cursor Settings → MCP, or `.cursor/mcp.json`.
|
|
32
|
+
- Add the config above under `mcpServers`.
|
|
33
|
+
|
|
34
|
+
### Claude Desktop
|
|
35
|
+
|
|
36
|
+
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
37
|
+
- **Windows:** `%APPDATA%\\Claude\\claude_desktop_config.json`
|
|
38
|
+
|
|
39
|
+
Add or merge the `mcpServers` block above.
|
|
40
|
+
|
|
41
|
+
### After configuring
|
|
42
|
+
|
|
43
|
+
1. Restart Cursor or Claude Desktop.
|
|
44
|
+
2. In chat, ask the assistant to use the `fetch_docs` tool (e.g. “Fetch ERSPO query documentation”).
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Features
|
|
49
|
+
|
|
50
|
+
- **`fetch_docs` tool** — Retrieves the documentation content from `docs.md`, including:
|
|
51
|
+
- Header & footer navigation (GraphQL queries + sample responses)
|
|
52
|
+
- Blog/article details (Our Story / Behind the scenes)
|
|
53
|
+
- Our Store, FAQ, Contact Us, Terms & Conditions, Privacy Policy
|
|
54
|
+
- URL patterns and pagination rules
|
|
55
|
+
|
|
56
|
+
## Requirements
|
|
57
|
+
|
|
58
|
+
- **Node.js** 18+
|
|
59
|
+
- **npm** or **yarn**
|
|
60
|
+
|
|
61
|
+
## Installation
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
git clone https://github.com/laskar-ksatria/mcp-erp.git
|
|
65
|
+
cd mcp-erp
|
|
66
|
+
npm install
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Usage
|
|
70
|
+
|
|
71
|
+
### Run the server (standalone)
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npm start
|
|
75
|
+
# or
|
|
76
|
+
npm run dev
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Test client (local testing)
|
|
80
|
+
|
|
81
|
+
A small Node client is included to test the MCP server without Cursor/Claude: it spawns the server over stdio, lists tools, and calls `fetch_docs` to print a preview of `docs.md`.
|
|
82
|
+
|
|
83
|
+
From the project root:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npm test
|
|
87
|
+
# or
|
|
88
|
+
npm run test:client
|
|
89
|
+
# or
|
|
90
|
+
node test-client.js
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
You should see: connection success, list of tools, and a preview of the docs content.
|
|
94
|
+
|
|
95
|
+
### Using the tool from an AI assistant
|
|
96
|
+
|
|
97
|
+
After the MCP server is configured, you can ask the assistant:
|
|
98
|
+
|
|
99
|
+
- "Fetch ERSPO Shopify query documentation"
|
|
100
|
+
- "What is the query for header navigation?"
|
|
101
|
+
- "Show the FAQ page documentation"
|
|
102
|
+
|
|
103
|
+
The `fetch_docs` tool will return the full contents of `docs.md` (GraphQL queries + sample responses).
|
|
104
|
+
|
|
105
|
+
## License
|
|
106
|
+
|
|
107
|
+
MIT © Laskar
|