@shoppexio/mcp-theme-server 0.1.2 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +29 -85
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,104 +1,48 @@
1
1
  # @shoppexio/mcp-theme-server
2
2
 
3
- Model Context Protocol server for Shoppex theme operations.
3
+ MCP server for Shoppex theme operations.
4
4
 
5
- Connect any MCP-capable client Claude Desktop, Claude Code, Cursor, Windsurf, Codex to your Shoppex themes. Inspect, edit, validate, preview, and publish themes directly from your LLM workflow.
5
+ Use this package when you want an MCP-compatible client like Claude Code, Codex, Cursor, or OpenCode to work against hosted Shoppex themes.
6
6
 
7
- ## Install
7
+ ## What It Exposes
8
+
9
+ The server exposes tools for:
10
+ - inspect and diff
11
+ - read and search
12
+ - apply changes
13
+ - create sections and pages
14
+ - validate, preview, publish, and rollback
15
+
16
+ ## Runtime Config
17
+
18
+ Set these environment variables before starting the server:
8
19
 
9
20
  ```bash
10
- npm install -g @shoppexio/mcp-theme-server
21
+ export SHOPPEX_API_KEY=shx_your_key
22
+ export SHOPPEX_API_URL=https://api.shoppex.io
11
23
  ```
12
24
 
13
- Or run without installing:
25
+ ## Start
26
+
27
+ Install and run from npm:
14
28
 
15
29
  ```bash
16
30
  npx -y @shoppexio/mcp-theme-server
17
31
  ```
18
32
 
19
- ## Claude Desktop
20
-
21
- Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
22
-
23
- ```json
24
- {
25
- "mcpServers": {
26
- "shoppex-themes": {
27
- "command": "npx",
28
- "args": ["-y", "@shoppexio/mcp-theme-server"],
29
- "env": {
30
- "SHOPPEX_API_KEY": "shx_your_dev_api_key"
31
- }
32
- }
33
- }
34
- }
33
+ Or, if you are working from this repo:
34
+
35
+ ```bash
36
+ bun packages/mcp-theme-server/bin/shoppex-mcp-theme-server.mjs
35
37
  ```
36
38
 
37
- Restart Claude Desktop. The themes tools appear under the tools menu.
38
-
39
- ## Cursor / Windsurf / Other
40
-
41
- Any MCP client with stdio transport works. Set the same env var and point to `shoppex-mcp-theme-server` as the command.
42
-
43
- ## Tools (19)
44
-
45
- | Tool | Purpose |
46
- |------|---------|
47
- | `theme.inspect` | Inspect theme structure and manifest |
48
- | `theme.diff` | Diff theme state against a target |
49
- | `theme.read_file` | Read one file from a theme |
50
- | `theme.search_files` | Search across theme files |
51
- | `theme.apply` | Apply a change set to a theme |
52
- | `theme.accept` | Accept a pending change |
53
- | `theme.create` | Scaffold a new theme |
54
- | `theme.create_section` | Add a section |
55
- | `theme.create_page` | Add a page |
56
- | `theme.update_config` | Update `theme.config.ts` |
57
- | `theme.preview` | Start a preview instance |
58
- | `theme.stop_preview` | Stop a preview instance |
59
- | `theme.publish` | Publish theme |
60
- | `theme.publish_status` | Check publish status |
61
- | `theme.validate` | Validate theme build |
62
- | `theme.settings_get` | Read theme settings |
63
- | `theme.settings_update` | Update theme settings |
64
- | `theme.backups` | List backups |
65
- | `theme.rollback` | Rollback to a previous version |
66
- | `theme.latest_run` | Inspect last run result |
67
-
68
- ## Required Scopes
69
-
70
- Your Shoppex Dev API key needs:
39
+ ## Auth
40
+
41
+ Recommended scopes:
71
42
  - `themes.read`
72
43
  - `themes.write`
73
44
 
74
- Create one at [dashboard.shoppex.io/developer/api](https://dashboard.shoppex.io/developer/api).
75
-
76
- ## Environment Variables
77
-
78
- | Variable | Required | Default |
79
- |----------|----------|---------|
80
- | `SHOPPEX_API_KEY` | yes | — |
81
- | `SHOPPEX_API_URL` | no | `https://api.shoppex.io` |
82
-
83
- ## Example Prompts
84
-
85
- Once connected in Claude Desktop:
86
-
87
- - "Inspect the Nebula theme and list its sections."
88
- - "Create a new Hero section in my Pulse theme with a purple gradient background."
89
- - "Preview the Classic theme with the accent color set to `#7C3AED`."
90
- - "Publish the current draft of my Starlight theme."
91
-
92
- ## Companion
93
-
94
- Pair with [`@shoppexio/mcp-commerce-server`](https://www.npmjs.com/package/@shoppexio/mcp-commerce-server) for products, orders, customers, coupons, and payment links.
95
-
96
- ## Docs
97
-
98
- - [AI Workflows](https://docs.shoppex.io/themes/ai-workflows)
99
- - [Build & Customize with AI](https://docs.shoppex.io/themes/build-and-customize-with-ai)
100
- - [Developer API](https://docs.shoppex.io/api-reference/introduction)
101
-
102
- ## License
45
+ ## Related Docs
103
46
 
104
- Proprietary. © Shoppex.
47
+ - AI Workflows: `https://docs.shoppex.io/themes/ai-workflows`
48
+ - Theme Control Plane: `https://docs.shoppex.io/themes/theme-control-plane`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shoppexio/mcp-theme-server",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "description": "Shoppex MCP server for theme control plane operations",
5
5
  "type": "module",
6
6
  "repository": {
@@ -38,6 +38,6 @@
38
38
  },
39
39
  "dependencies": {
40
40
  "@modelcontextprotocol/sdk": "^1.28.0",
41
- "@shoppexio/theme-control-client": "workspace:*"
41
+ "@shoppexio/theme-control-client": "^0.1.0"
42
42
  }
43
43
  }