@wix/mcp 1.0.7 → 1.0.9

package/README.md

@@ -1,164 +1,169 @@
-# General Config:
+# Wix MCP
 
-## From npm package:
+## Installation & Usage
 
+### From npm Package
+
+```sh
+npx @wix/mcp
 ```
-command: npx:
-args: ["@wix/mcp"]
+
+### Local Development
+
+1. Clone the repository
+2. Install dependencies
+3. Build the project
+
+Run locally with:
+
+```sh
+npx /Users/absolute/path/to/repo/dir/.
 ```
 
-## Local:
+Or directly with Node:
+
+```sh
+node /Users/absolute/path/to/build/bin-standalone.js
+```
+
+## Configuration Options
+
+### Tool Selection
 
-First: clone + install + build
+Enable specific standard tools (all enabled by default):
 
 ```
-command: npx
-args: ["/Users/absolute/path/to/repo/dir/."]
+--tools=WDS,REST,SDK,WIX_HEADLESS,BUILD_APPS
 ```
 
+### Experimental Tools
+
+Enable experimental tools (disabled by default):
+
 ```
-command: node
-args: ["/Users/absolute/path/to/build/bin.js"]
+--experimental=WIX_API,CLI_COMMAND
 ```
 
-# Optional config arguments:
+### CLI Mode
 
-### choose a tool:
-`--tools=WDS,REST,SDK,WIX_HEADLESS,BUILD_APPS` - specify which standard tools to enable (if not specified, all standard tools are enabled)
+Specify CLI mode:
 
-### enable experimental tools:
-`--experimental=WIX_API,CLI_COMMAND` - enable specific experimental tools (disabled by default)
+```
+--cli=wix-one
+```
 
-### choose a CLI mode:
-`--cli=wix-one` - specifies to use Wix One CLI mode (if not specified, default CLI mode is used)
+### Logger
 
-### choose a logger:
-`--logger=mcp` - log to MCP server (default)
-`--logger=file` - log to file (in `~/wix-mcp-log.txt`)
+Set logging output:
 
-Available tool options:
+- `--logger=mcp` (default, logs to MCP server)
+- `--logger=file` (logs to `~/wix-mcp-log.txt`)
 
-Standard tools (all enabled by default if no --tools specified):
-- `WDS`: Wix Design System Documentation tools (MCP tool: `SearchWixWDSDocumentation`)
-- `REST`: Wix REST API Documentation tools (MCP tool: `SearchWixRESTDocumentation`)
-- `SDK`: Wix SDK Documentation tools (MCP tool: `SearchWixSDKDocumentation`)
-- `BUILD_APPS`: Build Apps Documentation tools (MCP tool: `SearchBuildAppsDocumentation`)
-- `WIX_HEADLESS`: Wix Headless Documentation tools (MCP tool: `SearchWixHeadlessDocumentation`)
+### Tool Reference
 
-Experimental tools (disabled by default):
-- `WIX_API`: Wix API tools for calling APIs on a Wix app (MCP tool: `CallWixAPI`)
-- `CLI_COMMAND`: CLI commands for working with Wix apps (MCP tool: `RunWixCliCommand`)
+**Standard Tools:**
+- `WDS`: Wix Design System Documentation (`SearchWixWDSDocumentation`)
+- `REST`: Wix REST API Documentation (`SearchWixRESTDocumentation`)
+- `SDK`: Wix SDK Documentation (`SearchWixSDKDocumentation`)
+- `BUILD_APPS`: Build Apps Documentation (`SearchBuildAppsDocumentation`)
+- `WIX_HEADLESS`: Wix Headless Documentation (`SearchWixHeadlessDocumentation`)
 
-Note: Experimental tools are in early development and may have limited functionality or breaking changes. These tools are disabled by default and must be explicitly enabled via the --experimental argument, regardless of whether --tools is specified or not.
+**Experimental Tools:**
+- `WIX_API`: Wix API tools (`CallWixAPI`)
+- `CLI_COMMAND`: CLI commands for Wix apps (`RunWixCliCommand`)
 
-The tool enum value (e.g. `WDS`) is used in the `--tools` and `--experimental` arguments, while the MCP tool name (e.g. `SearchWixWDSDocumentation`) is what you'll see in the actual tool calls.
+> Experimental tools are in early development and may have limited functionality or breaking changes. They must be explicitly enabled with `--experimental`.
 
-# Resource Feature
+## Resources
 
-The resource feature provides access to Wix documentation through the MCP server. It:
+The resource feature provides access to Wix documentation via the MCP server:
 
-1. Fetches documentation indexes from specified Wix portals
-2. Makes documentation articles available as resources through the MCP server
-3. Allows fetching article content using the MCP protocol
+- Fetches documentation indexes from specified Wix portals
+- Makes documentation articles available as resources
+- Allows fetching article content using the MCP protocol
 
-Resources are accessible using the `wix-docs://` URI scheme, which maps to the corresponding Wix documentation URLs.
-It's exactly parallel to the real docs url, for example:
-Docs URL: https://dev.wix.com/docs/picasso/wix-ai-docs/best-practices/sdk-best-practices
-Resource URI: wix-docs://picasso/wix-ai-docs/best-practices/sdk-best-practices
+Resources use the `wix-docs://` URI scheme, which maps to Wix Docs URLs:
 
-pass:
-`--portals=<docs-portal-name>`
-to load all docs from the portal as resources
+- Docs URL: `https://dev.wix.com/docs/...`
+- Resource URI: `wix-docs://...`
 
+To load all docs from a portal:
 
-# Cursor
+```
+--portals=<docs-portal-name>
+```
 
-## Cursor MCP docs:
+## Cursor Integration
 
-https://docs.cursor.com/context/model-context-protocol
+### MCP Docs
 
-## Config:
+See: https://docs.cursor.com/context/model-context-protocol
 
-## using `~/.cursor/mcp.json`
+### Configuration (`~/.cursor/mcp.json`)
 
-### with npx:
+#### Using npm package
 
-```
+```json
 {
   "mcpServers": {
     "wix-local-mcp": {
       "command": "npx",
-      "args": [
-        "-y",
-        "@wix/mcp"
-      ]
+      "args": ["-y", "@wix/mcp"]
     }
   }
 }
 ```
 
-### With npx locally:
-```
+#### Using local build
+
+```json
 {
   "mcpServers": {
     "wix-local-mcp": {
       "command": "npx",
-      "args": [
-        "/Users/absolute/path/to/repo/dir/."
-      ]
+      "args": ["/Users/absolute/path/to/repo/dir/."]
     }
   }
 }
 ```
 
-### with node:
-
-1. clone
-2. build
+#### Using Node
 
-```
+```json
 {
   "mcpServers": {
     "wix-local-mcp": {
       "command": "node",
-      "args": [
-        "/Users/absolute/path/to/build/bin.js"
-      ]
+      "args": ["/Users/absolute/path/to/build/bin-standalone.js"]
     }
   }
 }
 ```
 
-### You can try using bun + index.ts 
+## Troubleshooting
 
-# Troubleshooting
-- check the logs from claude desktop / cursor
-- is the error related to node / fnm / nvm ? make sure you have the latest node version as the default on in the path
-- is the error related to npx? make sure you use -y and the correct npm registry
-- try including full path to node
-- try using bun and index.ts directly
-- make sure build files have permissions for cursor to access
-- log should be written to `~/wix-mcp-log.txt`
-- add .env file with `WIX_COOKIE=` to avoid rate limits on SDK tool use
+- Check logs from Claude Desktop or Cursor
+- For Node/fnm/nvm errors: ensure the latest Node version is set as default
+- For npx errors: use `-y` and the correct npm registry
+- Try specifying the full path to Node
+- Try using Bun and `index.ts` directly
+- Ensure build files have appropriate permissions
 
-## NVM possible fix:
-```
-  "wix-mcp-remote-prod": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@wix/mcp-remote",
-        "https://mcp.wix.com/sse"
-      ],
-      "env": {
-        "PATH": "<path-to-your-nvm-node-version>/bin"
-      }
-    }
+### NVM Example Fix
+
+```json
+"wix-mcp-remote-prod": {
+  "command": "npx",
+  "args": ["-y", "@wix/mcp-remote", "https://mcp.wix.com/sse"],
+  "env": {
+    "PATH": "<path-to-your-nvm-node-version>/bin"
+  }
+}
 ```
 
-## fnm possible fix:
+### FNM Example Fix
 
-```
+```json
 {
   "mcpServers": {
     "wix-mcp-remote-prod": {
@@ -172,5 +177,4 @@ https://docs.cursor.com/context/model-context-protocol
 }
 ```
 
-
-
+> Node 20 is required to build.