@wix/mcp 1.0.1 → 1.0.3

package/README.md

@@ -29,6 +29,9 @@ args: ["/Users/absolute/path/to/build/bin.js"]
 ### enable experimental tools:
 `--experimental=WIX_API,CLI_COMMAND` - enable specific experimental tools (disabled by default)
 
+### choose a CLI mode:
+`--cli=wix-one` - specifies to use Wix One CLI mode (if not specified, default CLI mode is used)
+
 ### choose a logger:
 `--logger=mcp` - log to MCP server (default)
 `--logger=file` - log to file (in `~/wix-mcp-log.txt`)

package/build/api-call/index.js

@@ -2,8 +2,15 @@ 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, 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,',
+        'If the error is related to error code "WDE0110: Wix Code not enabled." you should ask the user to do it in the editor',
+        '**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'),
@@ -76,7 +83,8 @@ export function addApiCallTool(server, getSiteAccessToken, getAccountAccessToken
         };
     });
     server.tool('ManageWixSite', `Use account level API in order to create a site, update a site and publish site.
-    ALWAYS use "SearchWixRESTDocumentation" to search for the API you should invoke, NEVER GUESS THE SITE API URL`, {
+    ALWAYS use "SearchWixRESTDocumentation" to search for the API you should invoke, NEVER GUESS THE SITE API URL
+    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`, {
         url: z
             .string()
             .describe('The url of the api to call - ALWAYS get the information from the Wix REST docs DONT GUESS IT, the URL MUST BE ABSOLUTE URL'),

package/build/bin.js

@@ -71,10 +71,11 @@ if (docsTools.length > 0) {
     logger.log('Adding docs tools:', docsTools);
     addDocsTools(server, docsTools);
 }
+const isWixOne = parsedArgs['cli'] === 'wix-one';
 const cliTools = activeTools.filter((tool) => VALID_CLI_TOOLS.includes(tool));
 if (cliTools.length > 0) {
-    logger.log('Adding cli tools:', cliTools);
-    addCliTools(server, cliTools);
+    logger.log('Adding cli tools:', cliTools, 'isWixOne:', isWixOne);
+    addCliTools(server, cliTools, isWixOne);
 }
 try {
     const portals = parsedArgs['portals']?.split(',') || [];

package/build/cli-tools/cli.d.ts

@@ -1,4 +1,4 @@
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 export declare const VALID_CLI_TOOLS: readonly ["WIX_API", "CLI_COMMAND", "CLI_COMMAND_INTERACTIVE_MODE"];
 export type CLITool = (typeof VALID_CLI_TOOLS)[number];
-export declare function addCliTools(server: McpServer, allowedTools?: CLITool[]): void;
+export declare function addCliTools(server: McpServer, allowedTools?: CLITool[], isWixOne?: boolean): void;

package/build/cli-tools/cli.js

@@ -13,12 +13,17 @@ export function addCliTools(server, allowedTools = [
     'WIX_API',
     'CLI_COMMAND',
     'CLI_COMMAND_INTERACTIVE_MODE'
-]) {
+], isWixOne = false) {
     if (allowedTools.includes('WIX_API')) {
         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',
@@ -240,7 +278,7 @@ export function addCliTools(server, allowedTools = [
                 // Format generate command with proper arguments
                 commandName = 'npx';
                 commandArgs = [
-                    'wix',
+                    isWixOne ? 'wix-one' : 'wix',
                     'app',
                     'generate',
                     '-t',
@@ -255,6 +293,9 @@ export function addCliTools(server, allowedTools = [
                 commandName = commandParts[0];
                 commandArgs = commandParts.slice(1);
             }
+            if (isWixOne && commandName === 'wix') {
+                commandName = 'wix-one';
+            }
             try {
                 logger.log(`Executing Wix CLI command: ${commandName} ${commandArgs.join(' ')}`);
                 // Execute with timeout

package/build/docs/docs.js

@@ -130,11 +130,15 @@ export const addDocsTools = (server, allowedTools = [
         });
     }
     if (allowedTools.includes('BUSINESS_SOLUTIONS')) {
-        server.tool('SearchWixSampleFlowsDocumentation', [
-            'Searches the official Wix Business solutions Sample flows documentations.',
-            'This tool provides guidance when there is a need to perform several actions over the Wix platform, and a sample flow is needed',
-            'For example, various ways to setup a new business, or an end to end user of user flow',
-            'Once the information is retrieved you can use Wix REST API docs in order to query the specific APIs you need to use in each step'
+        server.tool('WixBusinessFlowsDocumentation', [
+            'This tool provides step-by-step recipes for setting up complex Wix business solutions that involve multiple API calls.',
+            '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.',
+            '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()
@@ -152,7 +156,8 @@ export const addDocsTools = (server, allowedTools = [
                 const result = await runSemanticSearchAndFormat({
                     toolName: 'BUSINESS_SOLUTIONS',
                     toolParams: {
-                        searchTerm: 'Sample Flow for: ' + searchTerm
+                        searchTerm: '**RECIPE**:  Business Recipes - full setup flow for::: ' +
+                            searchTerm
                     },
                     maxResults: Math.max(1, Math.min(maxResults ?? 5, 15))
                 });
@@ -161,6 +166,10 @@ 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.`
                         }
                     ]
                 };

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,31 @@
+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.',
+        'You should let the user know that they can provide feedback to Wix using [Devs on Wix Discord community](https://discord.gg/GhdmDN926z). and suggest them to format the message using this tool',
+        '**IMPORTANT NOTES**',
+        '1. This tool is not sending the message formats it for users to use in discord',
+        '2. Mention in the provided message that it is related to Wix MCP and the tools provided'
+    ].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 over discord')
+    }, 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 them to send it over discord to Wix - [Devs on Wix Discord community](https://discord.gg/GhdmDN926z), if you have another tool to send it over discord, you can use it to send the message directly'
+                }
+            ]
+        };
+    });
+}

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/mcp",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A Model Context Protocol server for Wix AI tools",
   "type": "module",
   "bin": "./bin.js",
@@ -23,7 +23,7 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.9.0",
     "@sentry/node": "^9.13.0",
-    "@wix/panorama-client-node": "^3.227.0",
+    "@wix/panorama-client-node": "^3.228.0",
     "execa": "^9.5.2",
     "minimist": "^1.2.8",
     "strip-ansi": "^7.1.0",
@@ -63,5 +63,5 @@
       ]
     }
   },
-  "falconPackageHash": "45d0dbf4ab7e282591f50831a041971ab0ea17988030cb5d68ab0d86"
+  "falconPackageHash": "b6e838772abadece4f3efd3c6c47cb26389c06c162e4d629e98eca81"
 }