@oneentry/mcp-server 1.1.4 → 1.1.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 +130 -62
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,38 +1,102 @@
|
|
|
1
1
|
# OneEntry MCP Server
|
|
2
2
|
|
|
3
|
-
MCP server for OneEntry SDK —
|
|
3
|
+
MCP server for OneEntry SDK — gives AI assistants (Claude Code, Cursor, Windsurf) the rules, skills and SDK documentation needed to build OneEntry projects correctly.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Two ways to connect
|
|
8
|
+
|
|
9
|
+
| | npm package | Remote server |
|
|
10
|
+
| ------------ | ----------------------------- | -------------------------------------------- |
|
|
11
|
+
| **Install** | `npx -y @oneentry/mcp-server@latest` | No install — just a URL |
|
|
12
|
+
| **Works in** | Claude Code only | Claude Code, Cursor, Windsurf |
|
|
13
|
+
| **Requires** | Nothing | OneEntry project token + URL |
|
|
14
|
+
| **Provides** | Rules + Skills (context docs) | Rules + Skills + **SDK documentation tools** |
|
|
15
|
+
| **Best for** | Quick local setup | Full AI-assisted development |
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Option A — Remote server (recommended)
|
|
20
|
+
|
|
21
|
+
No installation. Works in Claude Code, Cursor, and Windsurf.
|
|
22
|
+
|
|
23
|
+
Provides everything the npm package does, plus **8 SDK documentation tools** that the AI calls automatically to get module docs, code examples, and TypeScript types.
|
|
24
|
+
|
|
25
|
+
You will need:
|
|
26
|
+
|
|
27
|
+
- **`YOUR_TOKEN`** — API token from your OneEntry admin panel
|
|
28
|
+
- **`yourproject.oneentry.cloud`** — your OneEntry project domain
|
|
29
|
+
|
|
30
|
+
### Claude Code — `.mcp.json` in project root
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"mcpServers": {
|
|
35
|
+
"oneentry": {
|
|
36
|
+
"type": "streamable-http",
|
|
37
|
+
"url": "https://mcp-sdk-js.oneentry.cloud/mcp",
|
|
38
|
+
"headers": {
|
|
39
|
+
"X-OneEntry-Token": "YOUR_TOKEN",
|
|
40
|
+
"X-OneEntry-URL": "https://yourproject.oneentry.cloud"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Cursor — `~/.cursor/mcp.json`
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"mcpServers": {
|
|
52
|
+
"oneentry": {
|
|
53
|
+
"url": "https://mcp-sdk-js.oneentry.cloud/mcp",
|
|
54
|
+
"headers": {
|
|
55
|
+
"X-OneEntry-Token": "YOUR_TOKEN",
|
|
56
|
+
"X-OneEntry-URL": "https://yourproject.oneentry.cloud"
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
```
|
|
6
62
|
|
|
7
|
-
|
|
63
|
+
### Windsurf
|
|
8
64
|
|
|
9
|
-
|
|
10
|
-
|-------------|----------------|
|
|
11
|
-
| **Resources** | Rules (`oneentry://rules/*`) + `CLAUDE.md` — readable context documents |
|
|
12
|
-
| **Prompts** | Skills (`create-page`, `inspect-api`, etc.) — invocable by the user |
|
|
65
|
+
Add via **Settings → MCP Servers**:
|
|
13
66
|
|
|
14
|
-
|
|
67
|
+
```
|
|
68
|
+
URL: https://mcp-sdk-js.oneentry.cloud/mcp?token=YOUR_TOKEN&url=https://yourproject.oneentry.cloud
|
|
69
|
+
Authentication: None
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Alternative — custom headers (instead of query params)
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
URL: https://mcp-sdk-js.oneentry.cloud/mcp
|
|
76
|
+
X-OneEntry-Token: YOUR_TOKEN
|
|
77
|
+
X-OneEntry-URL: https://yourproject.oneentry.cloud
|
|
78
|
+
```
|
|
15
79
|
|
|
16
80
|
---
|
|
17
81
|
|
|
18
|
-
##
|
|
82
|
+
## Option B — npm package (Claude Code only)
|
|
19
83
|
|
|
20
|
-
|
|
84
|
+
Serves rules and skills as readable context documents. No token required.
|
|
21
85
|
|
|
22
|
-
|
|
86
|
+
**npx — no install:**
|
|
23
87
|
|
|
24
88
|
```json
|
|
25
89
|
{
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
90
|
+
"mcpServers": {
|
|
91
|
+
"oneentry": {
|
|
92
|
+
"command": "npx",
|
|
93
|
+
"args": ["-y", "@oneentry/mcp-server@latest"]
|
|
94
|
+
}
|
|
30
95
|
}
|
|
31
|
-
}
|
|
32
96
|
}
|
|
33
97
|
```
|
|
34
98
|
|
|
35
|
-
|
|
99
|
+
**Global install:**
|
|
36
100
|
|
|
37
101
|
```bash
|
|
38
102
|
npm install -g @oneentry/mcp-server
|
|
@@ -40,25 +104,25 @@ npm install -g @oneentry/mcp-server
|
|
|
40
104
|
|
|
41
105
|
```json
|
|
42
106
|
{
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
107
|
+
"mcpServers": {
|
|
108
|
+
"oneentry": {
|
|
109
|
+
"command": "oneentry-mcp"
|
|
110
|
+
}
|
|
46
111
|
}
|
|
47
|
-
}
|
|
48
112
|
}
|
|
49
113
|
```
|
|
50
114
|
|
|
51
115
|
---
|
|
52
116
|
|
|
53
|
-
## ⚠️ Required: add to your project's CLAUDE.md
|
|
117
|
+
## ⚠️ Required for Claude Code: add to your project's CLAUDE.md
|
|
54
118
|
|
|
55
119
|
After connecting the MCP server, create or edit `CLAUDE.md` in the root of your project and add:
|
|
56
120
|
|
|
57
121
|
```
|
|
58
|
-
This project uses OneEntry CMS.
|
|
122
|
+
This project uses OneEntry CMS. MCP server oneentry is connected — use it to get SDK documentation, rules and code examples.
|
|
59
123
|
```
|
|
60
124
|
|
|
61
|
-
> **Without this, Claude Code
|
|
125
|
+
> **Without this, Claude Code may not use the MCP server automatically.**
|
|
62
126
|
|
|
63
127
|
---
|
|
64
128
|
|
|
@@ -66,44 +130,48 @@ This project uses OneEntry CMS. Before doing any work, call the `load-context` t
|
|
|
66
130
|
|
|
67
131
|
Read them in Claude Code by typing `@oneentry://rules/<name>`:
|
|
68
132
|
|
|
69
|
-
| URI
|
|
70
|
-
|
|
71
|
-
| `oneentry://claude-md`
|
|
72
|
-
| `oneentry://rules/
|
|
73
|
-
| `oneentry://rules/
|
|
74
|
-
| `oneentry://rules/
|
|
75
|
-
| `oneentry://rules/
|
|
76
|
-
| `oneentry://rules/
|
|
77
|
-
| `oneentry://rules/
|
|
78
|
-
| `oneentry://rules/
|
|
79
|
-
| `oneentry://rules/
|
|
80
|
-
| `oneentry://rules/
|
|
133
|
+
| URI | Description |
|
|
134
|
+
| ----------------------------------- | -------------------------------------- |
|
|
135
|
+
| `oneentry://claude-md` | Full CLAUDE.md — main SDK instructions |
|
|
136
|
+
| `oneentry://rules/linting` | Linting rules |
|
|
137
|
+
| `oneentry://rules/typescript` | TypeScript rules |
|
|
138
|
+
| `oneentry://rules/nextjs-pages` | Next.js pages, params as Promise |
|
|
139
|
+
| `oneentry://rules/attribute-values` | attributeValues access by type |
|
|
140
|
+
| `oneentry://rules/attribute-sets` | AttributeSets — schema vs values |
|
|
141
|
+
| `oneentry://rules/auth-provider` | AuthProvider — auth/signUp rules |
|
|
142
|
+
| `oneentry://rules/tokens` | Tokens & makeUserApi rules |
|
|
143
|
+
| `oneentry://rules/server-actions` | Server Actions rules |
|
|
144
|
+
| `oneentry://rules/forms` | Forms & FormsData rules |
|
|
145
|
+
| `oneentry://rules/orders` | Orders & Payments rules |
|
|
146
|
+
| `oneentry://rules/localization` | Localization, locale from params |
|
|
147
|
+
| `oneentry://rules/product-statuses` | Product statuses rules |
|
|
81
148
|
|
|
82
149
|
## Available prompts (skills)
|
|
83
150
|
|
|
84
|
-
Invoke in Claude Code with `/
|
|
85
|
-
|
|
86
|
-
| Prompt
|
|
87
|
-
|
|
88
|
-
| `oneentry-context`
|
|
89
|
-
| `setup-
|
|
90
|
-
| `
|
|
91
|
-
| `inspect-api`
|
|
92
|
-
| `create-
|
|
93
|
-
| `create-
|
|
94
|
-
| `create-product-
|
|
95
|
-
| `create-
|
|
96
|
-
| `create-
|
|
97
|
-
| `create-
|
|
98
|
-
| `create-
|
|
99
|
-
| `create-
|
|
100
|
-
| `create-
|
|
101
|
-
| `create-
|
|
102
|
-
| `create-
|
|
103
|
-
| `create-
|
|
104
|
-
| `create-
|
|
105
|
-
| `create-
|
|
106
|
-
| `create-
|
|
107
|
-
| `create-
|
|
108
|
-
|
|
109
|
-
|
|
151
|
+
Invoke in Claude Code with `/mcp__oneentry__<name>`:
|
|
152
|
+
|
|
153
|
+
| Prompt | Description |
|
|
154
|
+
| ---------------------------- | ----------------------------------------------------- |
|
|
155
|
+
| `oneentry-context` | Load full SDK context at session start |
|
|
156
|
+
| `setup-nextjs` | Initialize Next.js project |
|
|
157
|
+
| `setup-oneentry` | Initialize SDK in a Next.js project |
|
|
158
|
+
| `inspect-api` | Inspect real API markers and structure |
|
|
159
|
+
| `create-page` | Create Next.js page with CMS content |
|
|
160
|
+
| `create-auth` | Auth/registration form |
|
|
161
|
+
| `create-product-list` | Product catalog with filters and pagination |
|
|
162
|
+
| `create-product-card` | Single product card |
|
|
163
|
+
| `create-product-page` | Single product page with gallery and related products |
|
|
164
|
+
| `create-cart-manager` | Cart — Redux + persist |
|
|
165
|
+
| `create-favorites` | Favorites — Redux + persist |
|
|
166
|
+
| `create-filter-panel` | Filter panel with FilterContext |
|
|
167
|
+
| `create-checkout` | Checkout form + payment |
|
|
168
|
+
| `create-orders-list` | User orders list |
|
|
169
|
+
| `create-profile` | User profile page |
|
|
170
|
+
| `create-form` | Dynamic form from Forms API |
|
|
171
|
+
| `create-reviews` | Reviews with hierarchy |
|
|
172
|
+
| `create-menu` | Navigation menu with submenus |
|
|
173
|
+
| `create-search` | Search bar with debounce |
|
|
174
|
+
| `create-locale-switcher` | Locale switcher |
|
|
175
|
+
| `create-server-action` | Next.js Server Action |
|
|
176
|
+
| `create-subscription-events` | Price/availability subscription |
|
|
177
|
+
| `setup-playwright` | Setup Playwright testing framework |
|