@ikas/code-components-mcp 1.4.0-beta.12 → 1.4.0-beta.14

package/data/storefront-types.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-05-13T13:56:41.860Z",
+  "generatedAt": "2026-06-02T17:14:56.583Z",
   "types": [
     {
       "name": "IkasProductAttributeDetail",
@@ -119,7 +119,6 @@
       ],
       "filePath": "blog/category/index.ts",
       "relatedFunctions": [
-        "apiListBlogCategory",
         "getIkasBlogCategoryHref"
       ]
     },
@@ -259,7 +258,6 @@
       ],
       "filePath": "blog/index.ts",
       "relatedFunctions": [
-        "apiListBlog",
         "getIkasBlogHref",
         "getIkasBlogFormattedDate"
       ]
@@ -325,10 +323,7 @@
           "optional": true
         }
       ],
-      "filePath": "blog/meta-data/index.ts",
-      "relatedFunctions": [
-        "apiListBlogMetaData"
-      ]
+      "filePath": "blog/meta-data/index.ts"
     },
     {
       "name": "IkasBlogTag",
@@ -1014,11 +1009,6 @@
       ],
       "filePath": "cart/index.ts",
       "relatedFunctions": [
-        "apiGetCartById",
-        "apiSaveCart",
-        "apiSaveCartCouponCode",
-        "apiAddItemToCart",
-        "apiUpdateCartCampaignOffer",
         "changeCartItemQuantity",
         "isOrderLineItemAutoCreated",
         "findExistingCartItem",
@@ -1440,7 +1430,6 @@
       ],
       "filePath": "checkout-settings/index.ts",
       "relatedFunctions": [
-        "apiListCheckoutSettings",
         "getCustomerAddressValidationResult",
         "isValidCustomerAddress",
         "getOrderAddressValidationResult",
@@ -1554,10 +1543,7 @@
           "optional": false
         }
       ],
-      "filePath": "city/index.ts",
-      "relatedFunctions": [
-        "apiListCity"
-      ]
+      "filePath": "city/index.ts"
     },
     {
       "name": "IkasContactForm",
@@ -1683,10 +1669,7 @@
           "optional": false
         }
       ],
-      "filePath": "country/index.ts",
-      "relatedFunctions": [
-        "apiListCountry"
-      ]
+      "filePath": "country/index.ts"
     },
     {
       "name": "IkasCustomerAddressCity",
@@ -1990,7 +1973,6 @@
       ],
       "filePath": "customer/attribute/index.ts",
       "relatedFunctions": [
-        "apiListCustomerAttribute",
         "getCustomerAttributeAccountPagePermission",
         "getCustomerAttributeRegisterPageRequirement",
         "getCustomerAttributes"
@@ -2319,12 +2301,6 @@
       ],
       "filePath": "customer/index.ts",
       "relatedFunctions": [
-        "apiLogin",
-        "apiSocialLogin",
-        "apiRegister",
-        "apiGetCustomer",
-        "apiSaveCustomer",
-        "apiValidateOTPCode",
         "isCustomerSubscribed",
         "getCustomerBasicInfo",
         "saveCustomer"
@@ -2489,8 +2465,6 @@
       ],
       "filePath": "customer/review/index.ts",
       "relatedFunctions": [
-        "apiCreateCustomerReview",
-        "apiListCustomerReviews",
         "getIkasCustomerReviewFormattedDate",
         "sendReview"
       ]
@@ -2559,10 +2533,7 @@
           "optional": false
         }
       ],
-      "filePath": "customer/review/summary/index.ts",
-      "relatedFunctions": [
-        "apiListCustomerReviewSummary"
-      ]
+      "filePath": "customer/review/summary/index.ts"
     },
     {
       "name": "IkasCustomerReviewSummaryStar",
@@ -2857,10 +2828,7 @@
           "optional": false
         }
       ],
-      "filePath": "customer-settings/index.ts",
-      "relatedFunctions": [
-        "apiListCustomerSettings"
-      ]
+      "filePath": "customer-settings/index.ts"
     },
     {
       "name": "IkasDistrict",
@@ -2923,10 +2891,7 @@
           "optional": false
         }
       ],
-      "filePath": "district/index.ts",
-      "relatedFunctions": [
-        "apiListDistrict"
-      ]
+      "filePath": "district/index.ts"
     },
     {
       "name": "IkasFavoriteProduct",
@@ -2974,10 +2939,7 @@
           "optional": false
         }
       ],
-      "filePath": "favorite-product/index.ts",
-      "relatedFunctions": [
-        "apiListFavoriteProducts"
-      ]
+      "filePath": "favorite-product/index.ts"
     },
     {
       "name": "IkasFilterCategory",
@@ -3027,7 +2989,6 @@
       ],
       "filePath": "filter-category/index.ts",
       "relatedFunctions": [
-        "apiGetProductFilterData",
         "getIkasFilterCategoryHref",
         "getIkasFilterCategorySlug",
         "getProductListFilterCategories",
@@ -3100,10 +3061,7 @@
           "optional": true
         }
       ],
-      "filePath": "html-meta-data/index.ts",
-      "relatedFunctions": [
-        "apiListHTMLMetaData"
-      ]
+      "filePath": "html-meta-data/index.ts"
     },
     {
       "name": "IkasHTMLMetaDataOverride",
@@ -3307,7 +3265,10 @@
           "optional": false
         }
       ],
-      "filePath": "language-option/index.ts"
+      "filePath": "language-option/index.ts",
+      "relatedFunctions": [
+        "setLanguage"
+      ]
     },
     {
       "name": "IkasLastViewedProduct",
@@ -3325,10 +3286,7 @@
           "optional": false
         }
       ],
-      "filePath": "last-viewed-product/index.ts",
-      "relatedFunctions": [
-        "apiGetLastViewedProducts"
-      ]
+      "filePath": "last-viewed-product/index.ts"
     },
     {
       "name": "IkasLocaleOption",
@@ -3366,7 +3324,10 @@
           "optional": false
         }
       ],
-      "filePath": "locale-option/index.ts"
+      "filePath": "locale-option/index.ts",
+      "relatedFunctions": [
+        "setLocalization"
+      ]
     },
     {
       "name": "IkasLocationTranslations",
@@ -4141,10 +4102,7 @@
           "optional": true
         }
       ],
-      "filePath": "merchant-settings/index.ts",
-      "relatedFunctions": [
-        "apiListMerchantSettings"
-      ]
+      "filePath": "merchant-settings/index.ts"
     },
     {
       "name": "IkasMerchantSettingsCurrencyFormat",
@@ -4838,9 +4796,6 @@
       ],
       "filePath": "order/index.ts",
       "relatedFunctions": [
-        "apiGetOrders",
-        "apiGetOrderByEmail",
-        "apiCreateOrderRefundRequest",
         "getIkasOrderDistinctItemCount",
         "getIkasOrderTotalItemCount",
         "getIkasOrderDisplayedPackages",
@@ -4866,7 +4821,6 @@
         "getIkasOrderDisplayedAdjustments",
         "getIkasOrderHref",
         "getIkasOrderVariantNames",
-        "getOrderPackageOrderLineItems",
         "submitOrderTrackingForm",
         "refundOrder",
         "getOrders",
@@ -5165,7 +5119,6 @@
         "getOrderLineItemRefundQuantity",
         "setOrderLineItemRefundQuantity",
         "editOrderLineItem",
-        "getOrderPackageOrderLineItems",
         "changeItemQuantity",
         "changeCartItemQuantity",
         "isOrderLineItemAutoCreated",
@@ -5755,10 +5708,7 @@
           "optional": false
         }
       ],
-      "filePath": "order/package/index.ts",
-      "relatedFunctions": [
-        "getOrderPackageOrderLineItems"
-      ]
+      "filePath": "order/package/index.ts"
     },
     {
       "name": "IkasDisplayedPackage",
@@ -5959,10 +5909,7 @@
           "optional": false
         }
       ],
-      "filePath": "order/refund/settings/index.ts",
-      "relatedFunctions": [
-        "apiListOrderRefundSettings"
-      ]
+      "filePath": "order/refund/settings/index.ts"
     },
     {
       "name": "IkasOrderShippingLine",
@@ -6159,7 +6106,6 @@
       ],
       "filePath": "order/transaction/index.ts",
       "relatedFunctions": [
-        "apiListOrderTransactions",
         "getOrderTransactionFormattedAmount",
         "getOrderTransactionPaymentMethodTranslation",
         "getOrderTransactions"
@@ -6382,7 +6328,6 @@
       ],
       "filePath": "payment-gateway/index.ts",
       "relatedFunctions": [
-        "apiListPaymentGateway",
         "getCheckoutTotalFinalPrice",
         "getPaymentGatewayCalculatedAdditionalPrices"
       ]
@@ -6497,10 +6442,7 @@
           "optional": true
         }
       ],
-      "filePath": "product/attribute/index.ts",
-      "relatedFunctions": [
-        "apiListProductAttribute"
-      ]
+      "filePath": "product/attribute/index.ts"
     },
     {
       "name": "IkasProductAttributeOption",
@@ -6893,7 +6835,6 @@
       ],
       "filePath": "product/campaign/index.ts",
       "relatedFunctions": [
-        "apiGetProductCampaigns",
         "getProductCampaigns"
       ]
     },
@@ -7094,7 +7035,6 @@
         "isAcceptedProductOffer",
         "acceptProductOffer",
         "rejectProductOffer",
-        "isProductOfferAccepted",
         "changeItemQuantity",
         "changeCartItemQuantity",
         "getAcceptedOffers"
@@ -7183,7 +7123,6 @@
       ],
       "filePath": "product/filter/index.ts",
       "relatedFunctions": [
-        "apiGetProductFilterData",
         "isCustomValueFilter",
         "isBoxFilter",
         "isListFilter",
@@ -7732,9 +7671,6 @@
       "filePath": "product/index.ts",
       "relatedFunctions": [
         "apiSearchProducts",
-        "apiGetRelatedProducts",
-        "apiGetSuggestedProducts",
-        "apiListProductOptionSet",
         "getProductCustomerReviews",
         "getIkasProductAttributeProducts",
         "hasProductVariant",
@@ -8025,7 +7961,6 @@
       ],
       "filePath": "product/option-set/index.ts",
       "relatedFunctions": [
-        "apiListProductOptionSet",
         "initProductOptionSet",
         "setChildOptions",
         "initOptionValues",
@@ -8448,9 +8383,7 @@
       ],
       "filePath": "product/stock-location/index.ts",
       "relatedFunctions": [
-        "apiGetVariantStockLocations",
-        "getProductAvailableStockLocations",
-        "getStockLocationFullAddressText"
+        "getProductAvailableStockLocations"
       ]
     },
     {
@@ -9289,10 +9222,7 @@
           "optional": false
         }
       ],
-      "filePath": "product-option-file/index.ts",
-      "relatedFunctions": [
-        "apiUploadFile"
-      ]
+      "filePath": "product-option-file/index.ts"
     },
     {
       "name": "IkasRaffleDateRangeField",
@@ -9380,7 +9310,6 @@
       ],
       "filePath": "raffle/index.ts",
       "relatedFunctions": [
-        "apiListStorefrontRaffle",
         "isRaffleAvailable"
       ]
     },
@@ -9445,10 +9374,7 @@
           "optional": false
         }
       ],
-      "filePath": "raffle/index.ts",
-      "relatedFunctions": [
-        "apiListRaffleMetaData"
-      ]
+      "filePath": "raffle/index.ts"
     },
     {
       "name": "IkasRaffleParticipant",
@@ -9541,11 +9467,7 @@
           "optional": false
         }
       ],
-      "filePath": "raffle/index.ts",
-      "relatedFunctions": [
-        "apiSaveRaffleParticipant",
-        "apiListRaffleParticipants"
-      ]
+      "filePath": "raffle/index.ts"
     },
     {
       "name": "IkasRaffleAppliedProduct",
@@ -9733,10 +9655,7 @@
           "optional": false
         }
       ],
-      "filePath": "shipping-zone/index.ts",
-      "relatedFunctions": [
-        "apiGetAvailableShippingZones"
-      ]
+      "filePath": "shipping-zone/index.ts"
     },
     {
       "name": "IkasShippingZoneDistrict",
@@ -9891,10 +9810,7 @@
           "optional": false
         }
       ],
-      "filePath": "state/index.ts",
-      "relatedFunctions": [
-        "apiListState"
-      ]
+      "filePath": "state/index.ts"
     },
     {
       "name": "IkasStockLocationAddressCity",
@@ -10067,10 +9983,7 @@
           "optional": false
         }
       ],
-      "filePath": "stock-location/available/index.ts",
-      "relatedFunctions": [
-        "apiGetAvailableStockLocations"
-      ]
+      "filePath": "stock-location/available/index.ts"
     },
     {
       "name": "IkasStockLocation",
@@ -10118,10 +10031,7 @@
           "optional": false
         }
       ],
-      "filePath": "stock-location/index.ts",
-      "relatedFunctions": [
-        "apiListStockLocations"
-      ]
+      "filePath": "stock-location/index.ts"
     },
     {
       "name": "IkasStorefrontB2BSettings",
@@ -10553,10 +10463,7 @@
           "optional": false
         }
       ],
-      "filePath": "storefront/settings/index.ts",
-      "relatedFunctions": [
-        "apiGetStorefrontSettings"
-      ]
+      "filePath": "storefront/settings/index.ts"
     },
     {
       "name": "IkasStorefrontTheme",

package/dist/index.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { execFile } from "child_process";
 import * as fs from "fs";
+import * as os from "os";
 import * as path from "path";
 import { fileURLToPath } from "url";
 import { z } from "zod";
@@ -3015,6 +3017,130 @@ server.tool("get_section_migration_plan", "Returns concrete CLI commands and pro
         };
     }
 });
+// =============================================================================
+// Editor-action tools — drive the connected editor over the dev server's WS
+// (port 5201) by shelling out to `ikas-component <cmd>`. The CLI is the
+// canonical implementation; these tools are thin advertisements for the LLM.
+// =============================================================================
+function resolveIkasComponentBinary(projectRoot) {
+    if (!path.isAbsolute(projectRoot)) {
+        throw new Error(`project_root must be absolute: ${projectRoot}`);
+    }
+    if (!fs.existsSync(projectRoot) || !fs.statSync(projectRoot).isDirectory()) {
+        throw new Error(`project_root is not a directory: ${projectRoot}`);
+    }
+    const binDir = path.join(projectRoot, "node_modules", ".bin");
+    const candidates = os.platform() === "win32"
+        ? ["ikas-component.cmd", "ikas-component.exe", "ikas-component"]
+        : ["ikas-component"];
+    for (const name of candidates) {
+        const full = path.join(binDir, name);
+        if (fs.existsSync(full))
+            return full;
+    }
+    throw new Error(`ikas-component CLI not found at ${binDir}. Run \`npm install\` (or \`pnpm install\`) in ${projectRoot} first.`);
+}
+async function runIkasComponentCli(projectRoot, args) {
+    const bin = resolveIkasComponentBinary(projectRoot);
+    return new Promise((resolve) => {
+        execFile(bin, args, { cwd: projectRoot, windowsHide: true }, (err, stdout, stderr) => {
+            const exitCode = err && typeof err.code === "number"
+                ? err.code
+                : err
+                    ? 1
+                    : 0;
+            resolve({ stdout: stdout?.toString() ?? "", stderr: stderr?.toString() ?? "", exitCode });
+        });
+    });
+}
+function parseCliJson(stdout) {
+    const trimmed = stdout.trim();
+    if (!trimmed)
+        return null;
+    // CLI prints exactly one JSON object on stdout; if multiple lines appeared
+    // (e.g., warnings on stderr leaked), take the last non-empty line.
+    const last = trimmed.split("\n").map(l => l.trim()).filter(Boolean).pop();
+    if (!last)
+        return null;
+    try {
+        return JSON.parse(last);
+    }
+    catch {
+        return null;
+    }
+}
+async function callEditorAction(projectRoot, args) {
+    try {
+        const { stdout, stderr, exitCode } = await runIkasComponentCli(projectRoot, args);
+        const parsed = parseCliJson(stdout);
+        if (parsed) {
+            return { content: [{ type: "text", text: JSON.stringify(parsed, null, 2) }] };
+        }
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `CLI exited with code ${exitCode} and produced no parseable JSON.\n` +
+                        `stdout:\n${stdout || "(empty)"}\nstderr:\n${stderr || "(empty)"}`,
+                },
+            ],
+        };
+    }
+    catch (err) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Error: ${err instanceof Error ? err.message : String(err)}`,
+                },
+            ],
+        };
+    }
+}
+// Tool: list_editor_pages
+server.tool("list_editor_pages", "List pages in the connected editor's project. Returns id, name, pageType, slug for each page. Requires `ikas-component dev` to be running with the editor connected. Use the returned `id`s as the `pageId` argument to `add_section_to_page`.", {
+    project_root: z.string().describe("Absolute path to the code-component project (where `node_modules/.bin/ikas-component` lives)."),
+    port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
+}, async ({ project_root, port }) => {
+    const args = ["list-pages", ...(port ? ["--port", String(port)] : [])];
+    return callEditorAction(project_root, args);
+});
+// Tool: list_imported_sections
+server.tool("list_imported_sections", "List section-type code components already imported into the editor's project (theme.codeComponents, filtered to type=section). Use to confirm a component is ready to be placed on a page. The component must be built (`ikas-component build`/`dev`) and imported (`import_section`) before it can be added to a page. The returned `id` is the editor's id for the imported component — normally identical to the id in `ikas.config.json`, but it can differ if the dev component was deleted and re-scaffolded after a previous import. Always use the `id` from this tool, not from `ikas.config.json`, when calling `add_section_to_page`.", {
+    project_root: z.string().describe("Absolute path to the code-component project."),
+    port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
+}, async ({ project_root, port }) => {
+    const args = ["list-imported", "--sections-only", ...(port ? ["--port", String(port)] : [])];
+    return callEditorAction(project_root, args);
+});
+// Tool: import_section
+server.tool("import_section", "Import a built section-type code component into the editor's project. This copies the compiled JS/CSS/props into `theme.codeComponents` and auto-creates the wrapper section needed to place it on a page. Idempotent: re-running updates the existing entry in place. Required before `add_section_to_page`. The component must have been built (`ikas-component build`/`dev`).", {
+    project_root: z.string().describe("Absolute path to the code-component project."),
+    component_id: z.string().describe("Component id from `ikas.config.json` (strict — no name resolution)."),
+    port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
+}, async ({ project_root, component_id, port }) => {
+    const args = ["import", "--id", component_id, ...(port ? ["--port", String(port)] : [])];
+    return callEditorAction(project_root, args);
+});
+// Tool: add_section_to_page
+server.tool("add_section_to_page", "Place an already-imported section-type code component on a page in the editor. Equivalent to right-clicking the section in the dev-components panel and choosing \"Add to Page\". Errors if the component is not imported, is not section-type, or the page id is unknown. Use `list_editor_pages` to discover page ids and `list_imported_sections` to discover component ids.", {
+    project_root: z.string().describe("Absolute path to the code-component project."),
+    component_id: z.string().describe("Imported code component id from `list_imported_sections` — NOT the id in `ikas.config.json` (the two are usually the same but can diverge after a rescaffold)."),
+    page_id: z.string().describe("Target page id (from `list_editor_pages`)."),
+    index: z.number().int().nonnegative().optional().describe("Zero-based insertion index in the page; appends when omitted."),
+    port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
+}, async ({ project_root, component_id, page_id, index, port }) => {
+    const args = [
+        "add-to-page",
+        "--component-id",
+        component_id,
+        "--page-id",
+        page_id,
+        ...(typeof index === "number" ? ["--index", String(index)] : []),
+        ...(port ? ["--port", String(port)] : []),
+    ];
+    return callEditorAction(project_root, args);
+});
 // --- Start server ---
 async function main() {
     const transport = new StdioServerTransport();