@commercetools/commerce-mcp 1.0.6 → 2.0.0

package/dist/index.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACCEPTED_TOOLS = void 0;
+exports.resolveToolsForConfiguration = exports.applyResolvedToolsToConfiguration = exports.ACCEPTED_TOOLS = void 0;
 exports.parseArgs = parseArgs;
 exports.main = main;
 const modelcontextprotocol_1 = require("@commercetools/commerce-agent/modelcontextprotocol");
+const processors_1 = require("@commercetools/processors");
 const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
 const colors_1 = require("colors");
 const HIDDEN_ARGS = ['customerId', 'isAdmin', 'storeKey', 'businessUnitKey'];
@@ -21,121 +22,18 @@ const PUBLIC_ARGS = [
     'toolOutputFormat',
 ];
 const ACCEPTED_ARGS = [...PUBLIC_ARGS, ...HIDDEN_ARGS];
-exports.ACCEPTED_TOOLS = [
-    'business-unit.read',
-    'business-unit.create',
-    'business-unit.update',
-    'products.read',
-    'products.create',
-    'products.update',
-    'project.read',
-    'product-search.read',
-    'category.read',
-    'category.create',
-    'category.update',
-    'channel.read',
-    'channel.create',
-    'channel.update',
-    'product-selection.read',
-    'product-selection.create',
-    'product-selection.update',
-    'order.read',
-    'order.create',
-    'order.update',
-    'cart.read',
-    'cart.create',
-    'cart.update',
-    'customer.create',
-    'customer.read',
-    'customer.update',
-    'customer-group.read',
-    'customer-group.create',
-    'customer-group.update',
-    'quote.read',
-    'quote.create',
-    'quote.update',
-    'quote-request.read',
-    'quote-request.create',
-    'quote-request.update',
-    'staged-quote.read',
-    'staged-quote.create',
-    'staged-quote.update',
-    'standalone-price.read',
-    'standalone-price.create',
-    'standalone-price.update',
-    'product-discount.read',
-    'product-discount.create',
-    'product-discount.update',
-    'cart-discount.read',
-    'cart-discount.create',
-    'cart-discount.update',
-    'discount-code.read',
-    'discount-code.create',
-    'discount-code.update',
-    'product-type.read',
-    'product-type.create',
-    'product-type.update',
-    'bulk.create',
-    'bulk.update',
-    'inventory.read',
-    'inventory.create',
-    'inventory.update',
-    'store.read',
-    'store.create',
-    'store.update',
-    'review.read',
-    'review.create',
-    'review.update',
-    'tax-category.read',
-    'tax-category.create',
-    'tax-category.update',
-    'shipping-methods.read',
-    'shipping-methods.create',
-    'shipping-methods.update',
-    'payments.read',
-    'payments.create',
-    'payments.update',
-    'zone.read',
-    'zone.create',
-    'zone.update',
-    'product-tailoring.read',
-    'product-tailoring.create',
-    'product-tailoring.update',
-    'payment-methods.read',
-    'payment-methods.create',
-    'payment-methods.update',
-    'recurring-orders.read',
-    'recurring-orders.create',
-    'recurring-orders.update',
-    'shopping-lists.read',
-    'shopping-lists.create',
-    'shopping-lists.update',
-    'extensions.read',
-    'extensions.create',
-    'extensions.update',
-    'subscriptions.read',
-    'subscriptions.create',
-    'subscriptions.update',
-    'custom-objects.read',
-    'custom-objects.create',
-    'custom-objects.update',
-    'types.read',
-    'types.create',
-    'types.update',
-    'payment-intents.update',
-    'transactions.read',
-    'transactions.create',
-];
-// eslint-disable-next-line complexity
+var modelcontextprotocol_2 = require("@commercetools/commerce-agent/modelcontextprotocol");
+Object.defineProperty(exports, "ACCEPTED_TOOLS", { enumerable: true, get: function () { return modelcontextprotocol_2.ACCEPTED_TOOLS; } });
+Object.defineProperty(exports, "applyResolvedToolsToConfiguration", { enumerable: true, get: function () { return modelcontextprotocol_2.applyResolvedToolsToConfiguration; } });
+Object.defineProperty(exports, "resolveToolsForConfiguration", { enumerable: true, get: function () { return modelcontextprotocol_2.resolveToolsForConfiguration; } });
 function parseArgs(args) {
     const options = {};
     const env = {};
-    // eslint-disable-next-line complexity
     args.forEach((arg) => {
         if (arg.startsWith('--')) {
             const [key, value] = arg.slice(2).split('=');
             if (key == 'tools') {
-                options.tools = value.split(',');
+                options.tools = value.replace(/\s+/g, '').split(',');
             }
             else if (key == 'authType') {
                 env.authType = value;
@@ -181,6 +79,9 @@ function parseArgs(args) {
                     options.toolOutputFormat = value;
                 }
             }
+            else if (key == 'fieldFiltering') {
+                options.fieldFiltering = tryParseFieldFiltering(value);
+            }
             else if (key == 'logging') {
                 options.logging = value == 'true';
             }
@@ -210,8 +111,8 @@ function parseArgs(args) {
         if (tool == 'all' || tool == 'all.read') {
             return;
         }
-        if (!exports.ACCEPTED_TOOLS.includes(tool.trim())) {
-            throw new Error(`Invalid tool: ${tool}. Accepted tools are: ${exports.ACCEPTED_TOOLS.join(', ')}`);
+        if (!modelcontextprotocol_1.ACCEPTED_TOOLS.includes(tool.trim())) {
+            throw new Error(`Invalid tool: ${tool}. Accepted tools are: ${modelcontextprotocol_1.ACCEPTED_TOOLS.join(', ')}`);
         }
     });
     // Check for commercetools env vars
@@ -267,6 +168,71 @@ function parseArgs(args) {
     }
     return { options, env };
 }
+function tryParseFieldFiltering(fieldFilteringString) {
+    let fieldFilteringConfig;
+    try {
+        fieldFilteringConfig = JSON.parse(fieldFilteringString);
+    }
+    catch (error) {
+        throw new Error(`Invalid argument: fieldFiltering. Error parsing JSON: ${error}`);
+    }
+    if (typeof fieldFilteringConfig !== 'object' ||
+        fieldFilteringConfig === null ||
+        Array.isArray(fieldFilteringConfig)) {
+        throw new Error(`Invalid argument: fieldFiltering. Value must be a stringified object of type FieldFilteringManagerConfig.`);
+    }
+    if (fieldFilteringConfig.paths) {
+        if (!isFieldFilteringRuleArray(fieldFilteringConfig.paths)) {
+            throw new Error(`Invalid argument: fieldFiltering.paths. Value must be a stringified array of type { type: "filter" | "redact", value: string, value: boolean }`);
+        }
+    }
+    if (fieldFilteringConfig.properties) {
+        if (!isFieldFilteringRuleArray(fieldFilteringConfig.properties)) {
+            throw new Error(`Invalid argument: fieldFiltering.properties. Value must be a stringified array of type { type: "filter" | "redact", value: string, value: boolean }`);
+        }
+    }
+    if (fieldFilteringConfig.whitelistPaths) {
+        if (!isFieldFilteringRuleArray(
+        // add value property to whitelistPaths depsite irrelevance to reuse isFieldFilteringRuleArray logic
+        fieldFilteringConfig.whitelistPaths.map((path) => ({
+            ...path,
+            value: 'filter',
+        })))) {
+            throw new Error(`Invalid argument: fieldFiltering.whitelistPaths. Value must be a stringified array of type { value: string, value: boolean }`);
+        }
+    }
+    if (fieldFilteringConfig.includes) {
+        if (!isFieldFilteringRuleArray(fieldFilteringConfig.includes)) {
+            throw new Error(`Invalid argument: fieldFiltering.includes. Value must be a stringified array of type { type: "filter" | "redact", value: string, value: boolean }`);
+        }
+    }
+    if (fieldFilteringConfig.jsonRedactionText) {
+        if (typeof fieldFilteringConfig.jsonRedactionText !== 'string') {
+            throw new Error(`Invalid argument: fieldFiltering.jsonRedactionText. Value must be of type string`);
+        }
+    }
+    if (fieldFilteringConfig.urlRedactionText) {
+        if (typeof fieldFilteringConfig.urlRedactionText !== 'string') {
+            throw new Error(`Invalid argument: fieldFiltering.urlRedactionText. Value must be of type string`);
+        }
+    }
+    return fieldFilteringConfig;
+}
+function isFieldFilteringRuleArray(possibleRules) {
+    if (!Array.isArray(possibleRules)) {
+        return false;
+    }
+    return (possibleRules
+        .map((rule) => isFieldFilteringRule(rule))
+        .findIndex((bool) => bool === false) === -1);
+}
+function isFieldFilteringRule(possibleRule) {
+    const rule = possibleRule;
+    return (!!rule.value &&
+        typeof rule.value === 'string' &&
+        typeof rule.caseSensitive === 'boolean' &&
+        (rule.type === 'filter' || rule.type === 'redact'));
+}
 function createAuthConfig(env) {
     const baseConfig = {
         authUrl: env.authUrl,
@@ -315,46 +281,13 @@ async function main() {
             storeKey: options.storeKey,
             businessUnitKey: options.businessUnitKey,
             logging: options.logging,
+            fieldFiltering: options.fieldFiltering
+                ? new processors_1.FieldFilteringHandler(options.fieldFiltering)
+                : undefined,
         },
     };
-    if (selectedTools[0] === 'all') {
-        exports.ACCEPTED_TOOLS.forEach((tool) => {
-            if (!configuration.actions) {
-                configuration.actions = {};
-            }
-            const [namespace, action] = tool.split('.');
-            configuration.actions[namespace] = {
-                ...configuration.actions[namespace],
-                [action]: true,
-            };
-        });
-    }
-    else if (selectedTools[0] === 'all.read') {
-        exports.ACCEPTED_TOOLS.forEach((tool) => {
-            if (!configuration.actions) {
-                configuration.actions = {};
-            }
-            const [namespace, action] = tool.split('.');
-            if (action === 'read') {
-                configuration.actions[namespace] = {
-                    ...configuration.actions[namespace],
-                    [action]: true,
-                };
-            }
-        });
-    }
-    else {
-        selectedTools.forEach((tool) => {
-            if (!configuration.actions) {
-                configuration.actions = {};
-            }
-            const [namespace, action] = tool.split('.');
-            configuration.actions[namespace] = {
-                ...(configuration.actions[namespace] || {}),
-                [action]: true,
-            };
-        });
-    }
+    const resolution = (0, modelcontextprotocol_1.resolveToolsForConfiguration)(selectedTools, Boolean(options.isAdmin));
+    (0, modelcontextprotocol_1.applyResolvedToolsToConfiguration)(configuration, resolution);
     const authConfig = createAuthConfig(env);
     // eslint-disable-next-line require-await
     async function getServer() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/commerce-mcp",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "mcpName": "io.github.commercetools/commerce-mcp",
   "homepage": "https://github.com/commercetools/commerce-mcp",
   "description": "A command line tool for setting up commercetools MCP server",
@@ -19,11 +19,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.24.0",
+    "@modelcontextprotocol/sdk": "^1.26.0",
     "colors": "^1.4.0",
     "dotenv": "^17.2.1",
     "mcp-remote": "^0.1.18",
-    "@commercetools/commerce-agent": "1.0.6"
+    "@commercetools/commerce-agent": "2.0.0",
+    "@commercetools/processors": "0.0.0"
   },
   "keywords": [
     "mcp",
@@ -55,7 +56,7 @@
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "prebuild": "pnpm --filter @commercetools/commerce-agent run build",
+    "prebuild": "pnpm --filter @commercetools/processors run build && pnpm --filter @commercetools/commerce-agent run build",
     "dev": "concurrently -n BUILD,SERVER -c magenta,cyan \"pnpm dev:build\" \"pnpm dev:run\"",
     "dev:build": "tsup --env.NODE_ENV dev",
     "dev:run": "nodemon  dist/index.js --watch",