@wix/mcp 1.0.6 → 1.0.8

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

@@ -0,0 +1,4 @@
+import { WixMcpServer } from '../wix-mcp-server.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: WixMcpServer, allowedTools?: CLITool[], isWixOne?: boolean): void;

package/build/cli-tools/cli.js

@@ -0,0 +1,339 @@
+import { z } from 'zod';
+import { getCliAuthTokenForSiteId, getSiteIdFromCliAppConfig } from './utils.js';
+import { logger } from '../infra/logger.js';
+import { execa } from 'execa';
+import { mockInteractiveGenerateCommandTool } from '../interactive-command-tools/interactive-command-utils.js';
+import { handleWixAPIResponse } from '../tool-utils.js';
+export const VALID_CLI_TOOLS = [
+    'WIX_API',
+    'CLI_COMMAND',
+    'CLI_COMMAND_INTERACTIVE_MODE'
+];
+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 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'),
+            method: z
+                .string()
+                .describe('The HTTP method to use for the API call (e.g. GET, POST, PUT, DELETE)'),
+            body: z
+                .string()
+                .optional()
+                .describe('A string representing of a valid JSON object to describe the body of the request')
+        }, async ({ method, url, body, appPath, siteId }, { httpClient }) => {
+            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 httpClient.request({
+                    url,
+                    method: method,
+                    headers: {
+                        Authorization: authorization,
+                        'wix-site-id': siteIdToUse,
+                        ...(body ? { 'Content-Type': 'application/json' } : {})
+                    },
+                    data: method === 'GET' ? undefined : body
+                });
+                const responseData = await handleWixAPIResponse(response);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `Wix API call successful: ${JSON.stringify(responseData)}`
+                        }
+                    ]
+                };
+            }
+            catch (error) {
+                logger.error(`Failed to call Wix API: ${error}`);
+                throw new Error(`Failed to call Wix API: ${error}`);
+            }
+        });
+    }
+    if (allowedTools.includes('CLI_COMMAND_INTERACTIVE_MODE')) {
+        server.tool('RunWixCliCommandInteractiveMode', `Executes Wix CLI commands for Wix app development and management.
+    Use this tool to run commands like 'wix app generate' (adds new extensions), 'wix app build' (builds your app), 'wix app preview' (creates shareable preview), 'wix app release' (releases a new version of your app), and more.
+
+    IMPORTANT: Before using this tool, check if the command is mapped in package.json scripts:
+    * Use this tool for npm/yarn scripts that map to Wix CLI commands as well.
+    * Do not use this tool for starting the local development server.
+    
+    Before using this tool, you MUST search the Wix documentation for the command you want to run.
+    
+    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'),
+            extensionType: z
+                .enum(['DASHBOARD_PAGE', 'BACKEND_EVENT'])
+                .optional()
+                .describe('The type of extension to generate. You MUST provide this for commands that generate extensions.'),
+            searchedDocs: z
+                .boolean()
+                .describe('Whether you have already searched the Wix documentation for the command you want to run.'),
+            command: z
+                .string()
+                .min(1, 'Command cannot be empty')
+                .max(1000, 'Command is too long')
+                .describe("The Wix CLI command to execute (e.g. 'wix app generate', 'wix app build', 'wix app preview', 'wix app release', etc.), or a npm/yarn script that maps to a Wix CLI command (e.g. 'npm run generate', 'yarn build', etc.).")
+        }, async ({ command, appPath, extensionType }) => {
+            command = command.replace('wix app generate', 'npm run generate');
+            if (command.includes('generate') && !extensionType) {
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: "Error: You must provide an extension type for the 'generate' command."
+                        }
+                    ],
+                    isError: true
+                };
+            }
+            logger.log(`RunWixCliCommand: command: ${command}, appPath: ${appPath}, extensionType: ${extensionType}`);
+            try {
+                logger.log(`Executing Wix CLI command: ${command}`);
+                const commandParts = command.split(' ');
+                const commandName = commandParts[0];
+                const commandArgs = commandParts.slice(1);
+                // Execute with timeout
+                const subprocess = execa(commandName, commandArgs, {
+                    cwd: appPath,
+                    extendEnv: true,
+                    env: {
+                        ...process.env,
+                        PATH: process.env.PATH,
+                        WIX_CLI_TEST_OVERRIDES: JSON.stringify({
+                            inkDebug: true
+                        })
+                    },
+                    timeout: 5 * 60 * 1000, // 5 minute timeout
+                    maxBuffer: 10 * 1024 * 1024 // 10MB output limit
+                });
+                logger.log(`RunWixCliCommand: pid: ${subprocess.pid}`);
+                if (!subprocess.pid) {
+                    let spawnError;
+                    // make sure spawnError is defined by waiting for the error event
+                    if (!spawnError) {
+                        await new Promise((resolve) => {
+                            subprocess.on('error', (err) => {
+                                spawnError = err;
+                                resolve({ spawnError });
+                            });
+                        });
+                    }
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: `Failed to start the Wix CLI command process. This usually indicates a problem with the command or the environment. Are you sure Wix CLI is installed globally?\n\nCommand: ${command}\n\n${spawnError}`
+                            }
+                        ]
+                    };
+                }
+                const { stdin, stdout, stderr } = subprocess;
+                if (extensionType) {
+                    const output = await mockInteractiveGenerateCommandTool({
+                        extensionType,
+                        stdin,
+                        stdout
+                    });
+                    logger.log(`RunWixCliCommand: output: ${output}`);
+                    return {
+                        content: [{ type: 'text', text: output }]
+                    };
+                }
+                const stringifyStdout = JSON.stringify(stdout);
+                const stringifyStderr = JSON.stringify(stderr);
+                return {
+                    content: [
+                        { type: 'text', text: stringifyStdout },
+                        ...(stringifyStderr
+                            ? [{ type: 'text', text: `Error: ${stringifyStderr}` }]
+                            : [])
+                    ]
+                };
+            }
+            catch (error) {
+                logger.error(`Error executing Wix CLI command: ${error}`);
+                return {
+                    content: [{ type: 'text', text: `Error: ${error}` }],
+                    isError: true
+                };
+            }
+        });
+    }
+    if (allowedTools.includes('CLI_COMMAND')) {
+        server.tool('RunWixCliCommand', `Executes Wix CLI commands for Wix app development and management.
+    Use this tool to run commands like 'wix app generate' (adds new extensions), 'wix app build' (builds your app), 'wix app preview' (creates shareable preview), 'wix app release' (releases a new version of your app), and more.
+
+    IMPORTANT: Before using this tool, check if the command is mapped in package.json scripts:
+    * Use this tool for npm/yarn scripts that map to Wix CLI commands as well.
+    * Do not use this tool for starting the local development server.
+    
+    Before using this tool, you MUST search the Wix documentation for the command you want to run.
+    
+    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.'),
+            extensionType: z
+                .enum([
+                'dashboard-page',
+                'dashboard-plugin',
+                'dashboard-menu-plugin',
+                'dashboard-modal',
+                'web-method',
+                'api-route',
+                'event',
+                'service-plugin'
+            ])
+                .optional()
+                .describe('The type of extension to generate. You MUST provide this for commands that generate extensions.'),
+            extensionName: z
+                .string()
+                .optional()
+                .describe('The name of the extension to generate, e.g. My Dashboard Page. You MUST provide this for commands that generate extensions.'),
+            searchedDocs: z
+                .boolean()
+                .describe('Whether you have already searched the Wix documentation for the command you want to run.'),
+            command: z
+                .string()
+                .min(1, 'Command cannot be empty')
+                .max(1000, 'Command is too long')
+                .describe("The Wix CLI command to execute (e.g. 'wix app generate', 'wix app build', 'wix app preview', 'wix app release', etc.), or a script that maps to a Wix CLI command (e.g. 'npm run generate', 'yarn generate', etc.).")
+        }, async ({ command, appPath, extensionType, extensionName }) => {
+            logger.log(`RunWixCliCommand: command: ${command}, appPath: ${appPath}, extensionType: ${extensionType}, extensionName: ${extensionName}`);
+            let commandName = '';
+            let commandArgs = [];
+            if (command.includes('generate')) {
+                if (!extensionType) {
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: "Error: You must provide an extension type for the 'generate' command."
+                            }
+                        ],
+                        isError: true
+                    };
+                }
+                if (!extensionName) {
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: "Error: You must provide an extension name for the 'generate' command."
+                            }
+                        ],
+                        isError: true
+                    };
+                }
+                // Format generate command with proper arguments
+                commandName = 'npx';
+                commandArgs = [
+                    isWixOne ? 'wix-one' : 'wix',
+                    'app',
+                    'generate',
+                    '-t',
+                    extensionType,
+                    '-n',
+                    extensionName,
+                    '--json'
+                ];
+            }
+            else {
+                const commandParts = command.split(' ');
+                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
+                const { stdout, stderr, exitCode } = await execa(commandName, commandArgs, {
+                    cwd: appPath,
+                    extendEnv: true,
+                    env: {
+                        ...process.env
+                    },
+                    timeout: 5 * 60 * 1000, // 5 minute timeout
+                    maxBuffer: 10 * 1024 * 1024 // 10MB output limit
+                });
+                if (exitCode !== 0) {
+                    return {
+                        content: [{ type: 'text', text: `Error: ${stderr}` }],
+                        isError: true
+                    };
+                }
+                logger.log(`RunWixCliCommand: stdout: ${stdout}`);
+                logger.log(`RunWixCliCommand: stderr: ${stderr}`);
+                return {
+                    content: [
+                        { type: 'text', text: stdout },
+                        ...(stderr
+                            ? [{ type: 'text', text: `Error: ${stderr}` }]
+                            : [])
+                    ]
+                };
+            }
+            catch (error) {
+                logger.error(`Error executing Wix CLI command: ${error}`);
+                return {
+                    content: [{ type: 'text', text: `Error: ${error}` }],
+                    isError: true
+                };
+            }
+        });
+    }
+}

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

@@ -0,0 +1,2 @@
+export declare function getCliAuthTokenForSiteId(siteIdOrAccountsFileName: string): string;
+export declare function getSiteIdFromCliAppConfig(appPath: string): any;

package/build/cli-tools/utils.js

@@ -0,0 +1,25 @@
+import { existsSync, readFileSync } from 'fs';
+import { homedir } from 'os';
+import path from 'path';
+export function getCliAuthTokenForSiteId(siteIdOrAccountsFileName) {
+    // check if the api-key.json file exists:
+    const apiKeyFileName = path.join(homedir(), `.wix/auth/api-key.json`);
+    const apiKeyFileExists = existsSync(apiKeyFileName);
+    if (apiKeyFileExists) {
+        const apiKeyData = JSON.parse(readFileSync(apiKeyFileName, 'utf8'));
+        return (apiKeyData.token || apiKeyData.accessToken);
+    }
+    const siteTokenFileName = path.join(homedir(), `.wix/auth/${siteIdOrAccountsFileName}.json`);
+    // check if the site token file exists:
+    const siteTokenFileExists = existsSync(siteTokenFileName);
+    if (siteTokenFileExists) {
+        const authData = JSON.parse(readFileSync(siteTokenFileName, 'utf8'));
+        return (authData.accessToken || authData.token);
+    }
+    throw new Error('No site token or api key found. You need to authenticate with Wix CLI first.');
+}
+// f"first get the site id - its in the `{backoffice_app_dir}/.wix/app.config.json` file, it has a json object with a siteId field",
+export function getSiteIdFromCliAppConfig(appPath) {
+    const appConfig = JSON.parse(readFileSync(path.join(appPath, '.wix/app.config.json'), 'utf8'));
+    return appConfig.siteId;
+}

package/build/docs/docs.d.ts

@@ -0,0 +1,4 @@
+import type { WixMcpServer } from '../wix-mcp-server.js';
+export declare const VALID_DOCS_TOOLS: readonly ["WDS", "REST", "SDK", "BUILD_APPS", "WIX_HEADLESS", "BUSINESS_SOLUTIONS"];
+export type DocsTool = (typeof VALID_DOCS_TOOLS)[number];
+export declare const addDocsTools: (server: WixMcpServer, allowedTools?: DocsTool[]) => void;