@wix/mcp 1.0.2 → 1.0.4

package/README.md

@@ -140,3 +140,37 @@ https://docs.cursor.com/context/model-context-protocol
 - 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
+
+## 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"
+      }
+    }
+```
+
+## fnm possible fix:
+
+```
+{
+  "mcpServers": {
+    "wix-mcp-remote-prod": {
+      "command": "sh",
+      "args": [
+        "-c",
+        "eval $(fnm env) && npx -y @wix/mcp-remote https://mcp.wix.com/sse"
+      ]
+    }
+  }
+}
+```
+
+
+

package/build/api-call/index.js

@@ -2,8 +2,14 @@ import { z } from 'zod';
 import { logger } from '../logger.js';
 import { handleWixAPIResponse } from '../tool-utils.js';
 export function addApiCallTool(server, getSiteAccessToken, getAccountAccessToken) {
-    server.tool('CallWixSiteAPI', 'Call Wix apis on a business or site. Use this to create, read, update, and delete data and other Wix entities in your Wix site,' +
-        `You should ALWAYS check the rest docs - "SearchWixRESTDocumentation" for the specific API you want to call, don't just call it without knowing what it does, CHECK THE DOCS`, {
+    server.tool('CallWixSiteAPI', [
+        'Call Wix apis on a business or site. Use this to create, read, update, and delete data and other Wix entities in your Wix site,',
+        `You should ALWAYS check the rest docs - "SearchWixRESTDocumentation" for the specific API you want to call, don't just call it without knowing what it does, CHECK THE DOCS`,
+        'Error Handling:',
+        'If the error is related to missing installed app or "WDE0110: Wix Code not enabled", you should install the missing app by using ReadFullDocsArticle tool to fetch the article - https://dev.wix.com/docs/kb-only/MCP_REST_RECIPES_KB_ID/TRAIN_wix.devcenter.apps.installer.v1.AppsInstallerService.InstallApp',
+        '**Note:** there is no need to check if an app is installed/ Wix Code enabled in advance, just call the API and handle the error if it occurs, the API error message will state it clearly.',
+        'For any other error, use your default error handling mechanism'
+    ].join('\n'), {
         siteId: z
             .string()
             .describe('The id of the site selected using site selection tool'),

package/build/cli-tools/cli.js

@@ -18,7 +18,12 @@ export function addCliTools(server, allowedTools = [
         server.tool('CallWixAPI', 'Call Wix apis on an app. Use this to create, read, update, and delete data and other Wix entities in your Wix app.', {
             appPath: z
                 .string()
-                .describe('The dir path to the wix backoffice cli app to call the api on behalf of'), // should we have appPath or siteId here? (appPath encapsulates this more since we can get the siteId from the appPath then perform the call)
+                .describe('The dir path to the wix backoffice cli app to call the api on behalf of. should have {appPath}/.wix/app.config.json file with a siteId field. if passed, siteId is not required')
+                .optional(), // should we have appPath or siteId here? (appPath encapsulates this more since we can get the siteId from the appPath then perform the call)
+            siteId: z
+                .string()
+                .describe('The siteId of the wix backoffice cli app to call the api on behalf of. You can find the siteId in the {appPath}/.wix/app.config.json file. You can pass any other siteId if you want to call the api on behalf of a different site. If passed, appPath is not required. if not passed, the appPath must be provided.')
+                .optional(),
             url: z
                 .string()
                 .describe('The url of the api to call - usually you get this from the Wix REST docs or from the conversation context'),
@@ -29,11 +34,44 @@ export function addCliTools(server, allowedTools = [
                 .string()
                 .optional()
                 .describe('A string representing of a valid JSON object to describe the body of the request')
-        }, async ({ method, url, body, appPath }) => {
-            logger.log(`Calling Wix API: ${appPath} ${method} ${url}, body: ${JSON.stringify(body)}`);
-            const siteId = getSiteIdFromCliAppConfig(appPath);
-            logger.log(`Site ID for Wix API call: ${siteId}`);
-            const authorization = getCliAuthTokenForSiteId(siteId);
+        }, async ({ method, url, body, appPath, siteId }) => {
+            logger.log(`Calling Wix API: ${appPath} ${siteId} ${method} ${url}, body: ${JSON.stringify(body)}`);
+            if (!siteId && !appPath) {
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Either appPath or siteId must be provided'
+                        }
+                    ]
+                };
+            }
+            let siteIdToUse = siteId;
+            if (!siteIdToUse && appPath) {
+                siteIdToUse = getSiteIdFromCliAppConfig(appPath);
+            }
+            if (!siteIdToUse) {
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Either appPath or siteId must be provided'
+                        }
+                    ]
+                };
+            }
+            logger.log(`Site ID for Wix API call: ${siteIdToUse}`);
+            const authorization = getCliAuthTokenForSiteId(siteIdToUse);
+            if (!authorization) {
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Failed to get authorization token. Please check your siteId and appPath'
+                        }
+                    ]
+                };
+            }
             try {
                 const response = await fetch(url, {
                     method,
@@ -184,7 +222,7 @@ export function addCliTools(server, allowedTools = [
     DO NOT USE THIS TOOL FOR ANY OTHER PURPOSE. IT IS ONLY FOR WIX CLI COMMANDS.`, {
             appPath: z
                 .string()
-                .describe('The full path to the Wix CLI app to run the command on'),
+                .describe('The full path to the Wix CLI app to run the command on.'),
             extensionType: z
                 .enum([
                 'dashboard-page',

package/build/docs/docs.js

@@ -36,7 +36,7 @@ export const addDocsTools = (server, allowedTools = [
                 .max(15)
                 .optional()
                 .default(10)
-        }, async ({ searchTerm, maxResults }, { panorama }) => {
+        }, async ({ searchTerm, maxResults }) => {
             try {
                 logger.log(`Searching for ${searchTerm} in Wix WDS`);
                 const result = await runSemanticSearchAndFormat({
@@ -56,7 +56,7 @@ export const addDocsTools = (server, allowedTools = [
                 };
             }
             catch (error) {
-                panorama.errorMonitor().reportError(error);
+                // panorama.errorMonitor().reportError(error);
                 captureException(error, {
                     tags: {
                         componentId: 'SearchWixWDSDocumentation',
@@ -89,7 +89,7 @@ export const addDocsTools = (server, allowedTools = [
                 .max(15)
                 .optional()
                 .default(10)
-        }, async ({ searchTerm, maxResults }, { panorama }) => {
+        }, async ({ searchTerm, maxResults }) => {
             try {
                 logger.log(`Searching for ${searchTerm} in Wix REST API`);
                 const result = await runSemanticSearchAndFormat({
@@ -114,7 +114,7 @@ export const addDocsTools = (server, allowedTools = [
                 };
             }
             catch (error) {
-                panorama.errorMonitor().reportError(error);
+                // panorama.errorMonitor().reportError(error);
                 captureException(error, {
                     tags: {
                         componentId: 'SearchWixRESTDocumentation',
@@ -135,8 +135,10 @@ export const addDocsTools = (server, allowedTools = [
             'It excels at guiding the creation of features like booking systems with payments.',
             'For example, it can guide the setup of a service in Wix Bookings where customers can pay using Wix Payments, such as creating a bookable yoga class',
             'It searches the Wix Business Solutions documentation for these integrated workflows involving services, bookings, payments, stores, blogs, and more.',
-            'Before attempting to implement a multi step API calls on Wix, YOU MUST TRY THIS TOOL FIRST.',
-            'If the result includes a link to another article, use ReadFullDocsArticle tool to fetch the full article.'
+            'This tool returns a list of articles that are potentially relevant to the input search term.',
+            '**IMPORTANT NOTES:**',
+            '1. Before attempting to implement a multi step API calls on Wix, YOU MUST TRY THIS TOOL FIRST.',
+            '2. Out of the returned list of articles that you will receive, you MUST select the most relevant one and use the ReadFullDocsArticle tool to fetch it.'
         ].join('\n'), {
             searchTerm: z
                 .string()
@@ -148,7 +150,7 @@ export const addDocsTools = (server, allowedTools = [
                 .max(15)
                 .optional()
                 .default(5)
-        }, async ({ searchTerm, maxResults }, { panorama }) => {
+        }, async ({ searchTerm, maxResults }) => {
             try {
                 logger.log(`Searching for ${searchTerm} in Wix Sample Flows`);
                 const result = await runSemanticSearchAndFormat({
@@ -164,12 +166,16 @@ export const addDocsTools = (server, allowedTools = [
                         {
                             type: 'text',
                             text: result
+                        },
+                        {
+                            type: 'text',
+                            text: `Out of the included list of articles, you **MUST** select the one that is most relevant to the user's request and use the ReadFullDocsArticle tool to fetch it.`
                         }
                     ]
                 };
             }
             catch (error) {
-                panorama.errorMonitor().reportError(error);
+                // panorama.errorMonitor().reportError(error);
                 captureException(error, {
                     tags: {
                         componentId: 'SearchWixSampleFlowsDocumentation',
@@ -202,12 +208,12 @@ export const addDocsTools = (server, allowedTools = [
                 .max(15)
                 .optional()
                 .default(5)
-        }, async ({ searchTerm, maxResults }, { panorama }) => {
+        }, async ({ searchTerm, maxResults }) => {
             try {
                 logger.log(`Searching for ${searchTerm} in Wix SDK`);
-                panorama
-                    .transaction('SearchWixSDKDocumentation')
-                    .start({ maxResults });
+                // panorama
+                //   .transaction('SearchWixSDKDocumentation')
+                //   .start({ maxResults });
                 const result = await runSemanticSearchAndFormat({
                     toolName: 'SDK',
                     toolParams: {
@@ -216,9 +222,9 @@ export const addDocsTools = (server, allowedTools = [
                     maxResults: Math.max(1, Math.min(maxResults ?? 5, 15)),
                     linesInEachResult: 15
                 });
-                panorama
-                    .transaction('SearchWixSDKDocumentation')
-                    .finish({ maxResults });
+                // panorama
+                //   .transaction('SearchWixSDKDocumentation')
+                //   .finish({ maxResults });
                 return {
                     content: [
                         {
@@ -233,7 +239,7 @@ export const addDocsTools = (server, allowedTools = [
                 };
             }
             catch (error) {
-                panorama.errorMonitor().reportError(error);
+                // panorama.errorMonitor().reportError(error);
                 captureException(error, {
                     tags: {
                         componentId: 'SearchWixSDKDocumentation',
@@ -266,7 +272,7 @@ export const addDocsTools = (server, allowedTools = [
                 .max(15)
                 .optional()
                 .default(5)
-        }, async ({ searchTerm, maxResults }, { panorama }) => {
+        }, async ({ searchTerm, maxResults }) => {
             try {
                 logger.log(`Searching for ${searchTerm} in Build Apps`);
                 const result = await runSemanticSearchAndFormat({
@@ -286,7 +292,7 @@ export const addDocsTools = (server, allowedTools = [
                 };
             }
             catch (error) {
-                panorama.errorMonitor().reportError(error);
+                // panorama.errorMonitor().reportError(error);
                 captureException(error, {
                     tags: {
                         componentId: 'SearchBuildAppsDocumentation',
@@ -318,7 +324,7 @@ export const addDocsTools = (server, allowedTools = [
                 .max(15)
                 .optional()
                 .default(5)
-        }, async ({ searchTerm, maxResults }, { panorama }) => {
+        }, async ({ searchTerm, maxResults }) => {
             try {
                 logger.log(`Searching for ${searchTerm} in Headless`);
                 const result = await runSemanticSearchAndFormat({
@@ -338,7 +344,7 @@ export const addDocsTools = (server, allowedTools = [
                 };
             }
             catch (error) {
-                panorama.errorMonitor().reportError(error);
+                // panorama.errorMonitor().reportError(error);
                 captureException(error, {
                     tags: {
                         componentId: 'SearchWixHeadlessDocumentation',

package/build/index.d.ts

@@ -3,3 +3,4 @@ export { addDocsTools, DocsTool, VALID_DOCS_TOOLS } from './docs/docs.js';
 export { addApiCallTool } from './api-call/index.js';
 export { handleWixAPIResponse } from './tool-utils.js';
 export { addDocsResources } from './resources/docs.js';
+export { addSupportTool } from './support/index.js';

package/build/index.js

@@ -3,3 +3,4 @@ export { addDocsTools, VALID_DOCS_TOOLS } from './docs/docs.js';
 export { addApiCallTool } from './api-call/index.js';
 export { handleWixAPIResponse } from './tool-utils.js';
 export { addDocsResources } from './resources/docs.js';
+export { addSupportTool } from './support/index.js';

package/build/support/index.d.ts

@@ -0,0 +1,2 @@
+import { WixMcpServer } from '../wix-mcp-server.js';
+export declare function addSupportTool(server: WixMcpServer): void;

package/build/support/index.js

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+export function addSupportTool(server) {
+    server.tool('SupportAndFeedback', [
+        'If the user would like to provide Wix with some feedback (good or bad), about the tools in Wix MCP,',
+        'for example they used the tools provided, and they reflected satisfaction or dissatisfaction with the tools.',
+        'Also, if you encounter too many errors tyring to call the Wix API, you can also suggest the user to provide feedback to Wix using this tool.',
+        '**IMPORTANT NOTE**',
+        'This tool is not sending the message, but formats it in order to another tool to actually send it'
+    ].join('\n'), {
+        requestId: z
+            .string()
+            .optional()
+            .describe('request id if returned from the server in a failed API call to Wix'),
+        message: z.string().describe('The message to send to Wix')
+    }, async ({ requestId, message }) => {
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `${message} ${requestId ? `request id: ${requestId}` : ''}`
+                },
+                {
+                    type: 'text',
+                    text: 'You should present the user with the formatted message above and ask if they would like to send it to Wix.' +
+                        'If the user confirms, you can get the details about send feedback API from the article `https://dev.wix.com/docs/kb-only/MCP_REST_RECIPES_KB_ID/TRAIN_send_mcp_feedback_to_wix_from_user`.' +
+                        'You can use the `ReadFullDocsArticle` tool to fetch the article and get the details about the API call.' +
+                        'Once you have the details, you can use the `ManageWixSite` (if site id is in context) or `CallWixSiteAPI` (if site id is not in context) tool to call the API and send the feedback to Wix.'
+                }
+            ]
+        };
+    });
+}

package/build/tool-utils.js

@@ -18,7 +18,7 @@ export const handleWixAPIResponse = async (response) => {
             `Failed to call Wix API: ${response.status} ${response.statusText}.`,
             requestId ? `request id: ${requestId}` : '',
             // Wix 404 for API does not exist is huge (generic 404 page) and loaded to the context
-            response.status === 404 && errorDetails.includes('<html>')
+            response.status === 404 && errorDetails.includes('<html')
                 ? 'Not found'
                 : errorDetails
         ]

package/build/wix-mcp-server.d.ts

@@ -1,11 +1,8 @@
 import type { z, ZodRawShape, ZodTypeAny } from 'zod';
 import type { RequestHandlerExtra } from '@modelcontextprotocol/sdk/shared/protocol.js';
 import type { CallToolResult } from '@modelcontextprotocol/sdk/types.js';
-import type { PanoramaClientForComponent } from '@wix/panorama-client-node';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-type WixRequestHandlerExtra = RequestHandlerExtra & {
-    panorama: PanoramaClientForComponent;
-};
+type WixRequestHandlerExtra = RequestHandlerExtra & {};
 type WixToolCallback<Args extends undefined | ZodRawShape = undefined> = Args extends ZodRawShape ? (args: z.objectOutputType<Args, ZodTypeAny>, extra: WixRequestHandlerExtra) => CallToolResult | Promise<CallToolResult> : (extra: WixRequestHandlerExtra) => CallToolResult | Promise<CallToolResult>;
 export declare class WixMcpServer extends McpServer {
     tool(name: string, cb: WixToolCallback): void;

package/build/wix-mcp-server.js

@@ -1,6 +1,7 @@
+// import type { PanoramaClientForComponent } from '@wix/panorama-client-node';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-import { globalConfig, panoramaFactory } from './panorama.js';
-import { captureException, setTags } from '@sentry/node';
+//import { globalConfig, panoramaFactory } from './panorama.js';
+import { captureException } from '@sentry/node';
 export class WixMcpServer extends McpServer {
     tool(...args) {
         const cbIndex = args.findIndex((arg) => typeof arg === 'function');
@@ -8,29 +9,29 @@ export class WixMcpServer extends McpServer {
             const originalCb = args[cbIndex];
             const toolName = args[0];
             const panoramaComponentId = toolName;
-            const panorama = panoramaFactory.client({
-                baseParams: {
-                    componentId: panoramaComponentId
-                }
-            });
-            setTags({
-                panoramaSessionId: globalConfig.getSessionId()
-            });
+            /*const panorama = panoramaFactory.client({
+              baseParams: {
+                componentId: panoramaComponentId
+              }
+            });*/
+            /*setTags({
+              panoramaSessionId: globalConfig.getSessionId()
+            });*/
             const wrappedCb = async (...cbArgs) => {
                 const argsBeforeExtra = cbArgs.slice(0, cbArgs.length - 1);
                 const extra = cbArgs[cbArgs.length - 1];
                 const wrappedExtra = {
-                    ...extra,
-                    panorama: panorama.createClientForComponent()
+                    ...extra
+                    // panorama: panorama.createClientForComponent()
                 };
-                panorama.transaction(toolName).start();
+                //panorama.transaction(toolName).start();
                 try {
                     const cbResult = await originalCb(...argsBeforeExtra, wrappedExtra);
-                    panorama.transaction(toolName).finish();
+                    //panorama.transaction(toolName).finish();
                     return cbResult;
                 }
                 catch (e) {
-                    panorama.errorMonitor().reportError(e);
+                    //panorama.errorMonitor().reportError(e as Error);
                     captureException(e, {
                         tags: {
                             componentId: panoramaComponentId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/mcp",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A Model Context Protocol server for Wix AI tools",
   "type": "module",
   "bin": "./bin.js",
@@ -23,7 +23,6 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.9.0",
     "@sentry/node": "^9.13.0",
-    "@wix/panorama-client-node": "^3.227.0",
     "execa": "^9.5.2",
     "minimist": "^1.2.8",
     "strip-ansi": "^7.1.0",
@@ -32,17 +31,17 @@
     "zod": "^3.24.3"
   },
   "devDependencies": {
-    "@eslint/js": "^9.25.0",
+    "@eslint/js": "^9.25.1",
     "@types/express": "^5.0.1",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^20.17.30",
-    "eslint": "^9.25.0",
+    "@types/node": "^20.17.31",
+    "eslint": "^9.25.1",
     "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-prettier": "^5.2.6",
     "globals": "^16.0.0",
     "prettier": "^3.5.3",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.30.1",
+    "typescript-eslint": "^8.31.0",
     "vitest": "^3.1.2"
   },
   "exports": {
@@ -63,5 +62,5 @@
       ]
     }
   },
-  "falconPackageHash": "bebb972f9d803a633e2609035dfd5fc65e5498fe3690a8393291520b"
+  "falconPackageHash": "4fdd1bedb002c7deddf1dd04c2810b00c9864cbed6168260ad3a32d0"
 }

package/build/panorama.d.ts

@@ -1,2 +0,0 @@
-export declare const globalConfig: import("@wix/panorama-client-node").GlobalConfig<import("@wix/panorama-common-shared/dist/types/types/data-types.js").EventPayload, {}>;
-export declare const panoramaFactory: import("@wix/panorama-client").PanoramaClientFactory<import("@wix/panorama-common-shared/dist/types/types/data-types.js").EventPayload>;

package/build/panorama.js

@@ -1,23 +0,0 @@
-// import { createRequire } from 'module';
-import { createGlobalConfig, panoramaClientFactory, PanoramaPlatform } from '@wix/panorama-client-node';
-// const require = createRequire(import.meta.url);
-// const packageJson = require('../package.json');
-// TODO: use real package.json
-// I temporarily disabled this because it's not working in the remote server
-const packageJson = {
-    version: '1.0.0'
-};
-export const globalConfig = createGlobalConfig();
-export const panoramaFactory = panoramaClientFactory({
-    baseParams: {
-        platform: PanoramaPlatform.Standalone,
-        fullArtifactId: 'com.wixpress.spartans.wix-mcp',
-        artifactVersion: packageJson.version
-    },
-    data: {
-        packageVersion: packageJson.version,
-        versions: process.versions,
-        platform: process.platform,
-        arch: process.arch
-    }
-}).withGlobalConfig(globalConfig);