brinkcommerce-dev-mcp 0.1.0-beta.1

package/dist/tools/discount-tools.js

@@ -0,0 +1,575 @@
+import { createDiscountManagementClient } from "../api-client.js";
+import { logger } from "../logger.js";
+// ==================== TOOL ANNOTATIONS ====================
+// Annotations for read-only tools (GET operations)
+const readOnlyAnnotations = {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true, // Interacts with external BrinkCommerce APIs
+};
+// Annotations for write tools (POST, PUT, PATCH operations)
+const writeAnnotations = {
+    readOnlyHint: false,
+    destructiveHint: false, // Creates or updates, not destructive
+    openWorldHint: true,
+    idempotentHint: true, // PUT/PATCH are idempotent
+};
+// Annotations for destructive tools (DELETE operations)
+const destructiveAnnotations = {
+    readOnlyHint: false,
+    destructiveHint: true,
+    openWorldHint: true,
+};
+/**
+ * MCP Tool Definitions for Discount Management
+ */
+export const discountTools = {
+    run_discounts: {
+        name: "run_discounts",
+        description: "Run discount calculations for a set of cart items. This evaluates discount rules and returns applicable discounts. " +
+            "Used to calculate discounts before checkout.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                storeGroupId: {
+                    type: "string",
+                    description: "Store group ID for the discount calculation",
+                },
+                countryCode: {
+                    type: "string",
+                    description: "ISO-3166-1 alpha-2 country code (e.g., SE, NO, DK)",
+                    pattern: "^[A-Z]{2}$",
+                },
+                currencyCode: {
+                    type: "string",
+                    description: "ISO 4217 currency code (e.g., SEK, NOK, EUR)",
+                    pattern: "^[A-Z]{3}$",
+                },
+                items: {
+                    type: "array",
+                    description: "Array of cart items to calculate discounts for",
+                    items: {
+                        type: "object",
+                        properties: {
+                            productVariantId: {
+                                type: "string",
+                                description: "Product variant ID",
+                            },
+                            quantity: {
+                                type: "integer",
+                                description: "Quantity of items",
+                                minimum: 1,
+                            },
+                            unitPrice: {
+                                type: "integer",
+                                description: "Unit price in minor currency units (e.g., cents)",
+                                minimum: 0,
+                            },
+                            tags: {
+                                type: "object",
+                                description: "Tags for discount matching",
+                            },
+                        },
+                        required: ["productVariantId", "quantity", "unitPrice"],
+                    },
+                },
+                discountCartRules: {
+                    type: "array",
+                    description: "Optional cart-level discount rules to apply",
+                },
+                discountCodeRules: {
+                    type: "array",
+                    description: "Optional discount code rules to apply",
+                },
+                discountExternalRules: {
+                    type: "array",
+                    description: "Optional external discount rules to apply",
+                },
+            },
+            required: ["storeGroupId", "countryCode", "currencyCode", "items"],
+        },
+        annotations: readOnlyAnnotations, // Calculates discounts, doesn't modify data
+    },
+    get_bundle_group: {
+        name: "get_bundle_group",
+        description: "Get a bundle group configuration by ID. Bundle groups define product bundles for bundle discounts.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                bundleGroupId: {
+                    type: "string",
+                    description: "Unique identifier for the bundle group",
+                },
+            },
+            required: ["bundleGroupId"],
+        },
+        annotations: readOnlyAnnotations,
+    },
+    create_or_update_bundle_group: {
+        name: "create_or_update_bundle_group",
+        description: "Create or update a bundle group configuration. Bundle groups define which products can be bundled together for discounts.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                bundleGroupId: {
+                    type: "string",
+                    description: "Unique identifier for the bundle group",
+                },
+                name: {
+                    type: "string",
+                    description: "Display name for the bundle group",
+                },
+                storeMarkets: {
+                    type: "object",
+                    description: "Store groups with corresponding markets. Format: { 'storeGroupId': ['SE', 'NO'] }",
+                    additionalProperties: {
+                        type: "array",
+                        items: { type: "string" },
+                    },
+                },
+                bundles: {
+                    type: "array",
+                    description: "Array of bundle configurations",
+                },
+                isActive: {
+                    type: "boolean",
+                    description: "Whether the bundle group is active",
+                    default: true,
+                },
+            },
+            required: ["bundleGroupId", "name", "storeMarkets", "bundles", "isActive"],
+        },
+        annotations: writeAnnotations,
+    },
+    delete_bundle_group: {
+        name: "delete_bundle_group",
+        description: "Delete a bundle group. WARNING: This permanently removes the bundle group configuration. " +
+            "WHY CONFIRMATION MATTERS: Deleting a bundle group affects active discount rules that reference it, " +
+            "potentially breaking live promotions.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                bundleGroupId: {
+                    type: "string",
+                    description: "Unique identifier for the bundle group to delete",
+                },
+            },
+            required: ["bundleGroupId"],
+        },
+        annotations: destructiveAnnotations,
+    },
+    create_discount_code: {
+        name: "create_discount_code",
+        description: "Create a new discount code. Discount codes can be shared with customers for promotional discounts.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                discountCodeRuleId: {
+                    type: "string",
+                    description: "ID of the discount code rule this code connects to",
+                },
+                code: {
+                    type: "string",
+                    description: "The actual discount code string customers will enter (case insensitive)",
+                },
+                isUnlimited: {
+                    type: "boolean",
+                    description: "Whether the code can be used unlimited times. If true, usageLimit is ignored.",
+                    default: false,
+                },
+                usageLimit: {
+                    type: "integer",
+                    description: "Maximum number of times this code can be used (only used if isUnlimited is false)",
+                    minimum: 1,
+                },
+                validFrom: {
+                    type: "string",
+                    description: "ISO 8601 datetime when the code becomes valid (optional)",
+                    format: "date-time",
+                },
+                validTo: {
+                    type: "string",
+                    description: "ISO 8601 datetime when the code expires (optional)",
+                    format: "date-time",
+                },
+            },
+            required: ["discountCodeRuleId", "code", "isUnlimited"],
+        },
+        annotations: writeAnnotations,
+    },
+};
+/**
+ * Handle run_discounts tool call
+ */
+export async function handleRunDiscounts(params) {
+    try {
+        logger.info("Handling run_discounts tool call", {
+            storeGroupId: params.storeGroupId,
+            countryCode: params.countryCode,
+            currencyCode: params.currencyCode,
+        });
+        // Validate required parameters
+        const requiredFields = ["storeGroupId", "countryCode", "currencyCode", "items"];
+        for (const field of requiredFields) {
+            if (!params[field]) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: `Error: Missing required field '${field}'`,
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+        }
+        const storeGroupId = params.storeGroupId;
+        const countryCode = params.countryCode;
+        const currencyCode = params.currencyCode;
+        const items = params.items;
+        // Validate items array
+        if (!Array.isArray(items) || items.length === 0) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "Error: items must be a non-empty array",
+                    },
+                ],
+                isError: true,
+            };
+        }
+        // Create API client
+        const client = createDiscountManagementClient();
+        // Build request
+        const request = {
+            storeGroupId,
+            countryCode,
+            currencyCode,
+            items: items,
+            discountCartRules: params.discountCartRules,
+            discountCodeRules: params.discountCodeRules,
+            discountExternalRules: params.discountExternalRules,
+        };
+        // Call API
+        const result = await client.runDiscounts(request);
+        if (result.success) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully ran discount calculations\n\nStore Group: ${storeGroupId}\nCountry: ${countryCode}\nCurrency: ${currencyCode}\nItems processed: ${items.length}\n\nResult:\n${JSON.stringify(result.data, null, 2)}`,
+                    },
+                ],
+            };
+        }
+        else {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to run discounts: ${result.error?.message}\n\nStatus: ${result.error?.status}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    }
+    catch (error) {
+        logger.error("Error in handleRunDiscounts", { error });
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Unexpected error: ${error instanceof Error ? error.message : "Unknown error"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Handle get_bundle_group tool call
+ */
+export async function handleGetBundleGroup(params) {
+    try {
+        logger.info("Handling get_bundle_group tool call", {
+            bundleGroupId: params.bundleGroupId,
+        });
+        // Validate required parameters
+        if (!params.bundleGroupId) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "Error: Missing required field 'bundleGroupId'",
+                    },
+                ],
+                isError: true,
+            };
+        }
+        const bundleGroupId = params.bundleGroupId;
+        // Create API client
+        const client = createDiscountManagementClient();
+        // Call API
+        const result = await client.getBundleGroup(bundleGroupId);
+        if (result.success) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Bundle Group: ${bundleGroupId}\n\n${JSON.stringify(result.data, null, 2)}`,
+                    },
+                ],
+            };
+        }
+        else {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to get bundle group: ${result.error?.message}\n\nStatus: ${result.error?.status}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    }
+    catch (error) {
+        logger.error("Error in handleGetBundleGroup", { error });
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Unexpected error: ${error instanceof Error ? error.message : "Unknown error"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Handle create_or_update_bundle_group tool call
+ */
+export async function handleCreateOrUpdateBundleGroup(params) {
+    try {
+        logger.info("Handling create_or_update_bundle_group tool call", {
+            bundleGroupId: params.bundleGroupId,
+        });
+        // Validate required parameters
+        const requiredFields = ["bundleGroupId", "name", "storeMarkets", "bundles"];
+        for (const field of requiredFields) {
+            if (!params[field]) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: `Error: Missing required field '${field}'`,
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+        }
+        const bundleGroupId = params.bundleGroupId;
+        const name = params.name;
+        const storeMarkets = params.storeMarkets;
+        const bundles = params.bundles;
+        const isActive = params.isActive !== false; // Default to true
+        // Create API client
+        const client = createDiscountManagementClient();
+        // Build request
+        const request = {
+            name,
+            storeMarkets,
+            bundles: new Set(bundles),
+            isActive,
+        };
+        // Call API
+        const result = await client.createOrUpdateBundleGroup(bundleGroupId, request);
+        if (result.success) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully created/updated bundle group: ${bundleGroupId}\n\nName: ${name}\nActive: ${isActive}\n\n${JSON.stringify(result.data, null, 2)}`,
+                    },
+                ],
+            };
+        }
+        else {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to create/update bundle group: ${result.error?.message}\n\nStatus: ${result.error?.status}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    }
+    catch (error) {
+        logger.error("Error in handleCreateOrUpdateBundleGroup", { error });
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Unexpected error: ${error instanceof Error ? error.message : "Unknown error"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Handle delete_bundle_group tool call
+ */
+export async function handleDeleteBundleGroup(params) {
+    try {
+        logger.info("Handling delete_bundle_group tool call", {
+            bundleGroupId: params.bundleGroupId,
+        });
+        // Validate required parameters
+        if (!params.bundleGroupId) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "Error: Missing required field 'bundleGroupId'",
+                    },
+                ],
+                isError: true,
+            };
+        }
+        const bundleGroupId = params.bundleGroupId;
+        // Create API client
+        const client = createDiscountManagementClient();
+        // Call API
+        const result = await client.deleteBundleGroup(bundleGroupId);
+        if (result.success) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully deleted bundle group: ${bundleGroupId}`,
+                    },
+                ],
+            };
+        }
+        else {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to delete bundle group: ${result.error?.message}\n\nStatus: ${result.error?.status}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    }
+    catch (error) {
+        logger.error("Error in handleDeleteBundleGroup", { error });
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Unexpected error: ${error instanceof Error ? error.message : "Unknown error"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}
+/**
+ * Handle create_discount_code tool call
+ */
+export async function handleCreateDiscountCode(params) {
+    try {
+        logger.info("Handling create_discount_code tool call", {
+            code: params.code,
+        });
+        // Validate required parameters
+        const requiredFields = ["discountCodeRuleId", "code"];
+        for (const field of requiredFields) {
+            if (!params[field]) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: `Error: Missing required field '${field}'`,
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+        }
+        // isUnlimited is required but could be false
+        if (params.isUnlimited === undefined) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Error: Missing required field 'isUnlimited'`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+        const discountCodeRuleId = params.discountCodeRuleId;
+        const code = params.code;
+        const isUnlimited = params.isUnlimited;
+        // Create API client
+        const client = createDiscountManagementClient();
+        // Build request - construct valid date range if both dates provided
+        const validDateRange = params.validFrom && params.validTo
+            ? {
+                from: new Date(params.validFrom),
+                to: new Date(params.validTo),
+            }
+            : undefined;
+        const request = {
+            discountCodeRuleId,
+            code,
+            isUnlimited,
+            usageLimit: params.usageLimit,
+            validDateRange,
+        };
+        // Call API
+        const result = await client.createDiscountCode(request);
+        if (result.success) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully created discount code: ${code}\n\nDiscount Code Rule ID: ${discountCodeRuleId}\nUnlimited: ${isUnlimited}\n\n${JSON.stringify(result.data, null, 2)}`,
+                    },
+                ],
+            };
+        }
+        else {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Failed to create discount code: ${result.error?.message}\n\nStatus: ${result.error?.status}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    }
+    catch (error) {
+        logger.error("Error in handleCreateDiscountCode", { error });
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Unexpected error: ${error instanceof Error ? error.message : "Unknown error"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}

package/dist/tools/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * BrinkCommerce MCP Tools
+ *
+ * This module exports all tool definitions and handlers for BrinkCommerce operations.
+ */
+export { productTools, handleGetProductParent, handleCreateProductParent, handleDeleteProductParent, handlePatchProductParent, handleArchiveProductParent, handleGetProductVariant, handleListProductVariants, handleCreateProductVariant, handleDeleteProductVariant, handlePatchProductVariant, handleGetAddon, handleCreateOrUpdateAddon, handleDeleteAddon, handlePatchAddon, handleListProductParentAddons, handleAddProductParentAddon, handleRemoveProductParentAddon, } from "./product-tools.js";
+export { storeTools, handleCreateOrUpdateStoreGroup, handleCreateOrUpdateStoreMarket, handleDeleteStoreGroup, handleDeleteStoreMarket, handleListStoreGroups, handleGetStoreGroup, handleListStoreMarkets, handlePatchStoreGroup, handlePatchStoreMarket, } from "./store-tools.js";
+export { stockTools, handleUpdateProductVariantInventory, handleDeleteProductVariantInventory, handleListInventories, handleGetInventory, handleCreateOrUpdateInventory, handleDeleteInventory, handleGetProductVariantStock, handleUpdateProductVariantStockConfig, handlePatchProductVariantInventory, handleGetStoreMarketInventories, handleUpdateStoreMarketInventories, } from "./stock-tools.js";
+export { priceTools, handleUpdateProductVariantPrices, handleDeleteProductVariantPrices, handleGetProductVariantAllPrices, handleGetProductVariantPrices, handleGetProductVariantPrice, handleGetAddonPrice, handlePatchProductVariantPrices, } from "./price-tools.js";
+export { orderTools, handleGetOrder, handleGetOrderByReference, handleCancelOrder, handleRefundOrder, handleImportOrder, handleGetImportedOrder, handleCreateDelivery, handleGetDelivery, handleUpdateDelivery, handleDeleteDelivery, handleStartDelivery, handleRestartDelivery, handleGetCancellation, handleDeleteCancellation, handleStartCancellation, handleRestartCancellation, handleGetRefund, handleUpdateRefund, handleDeleteRefund, handleStartRefund, handleRestartRefund, handleCreateRelease, handleGetRelease, handleDeleteRelease, handleStartRelease, handleRestartRelease, } from "./order-tools.js";
+export { discountTools, handleRunDiscounts, handleGetBundleGroup, handleCreateOrUpdateBundleGroup, handleDeleteBundleGroup, handleCreateDiscountCode, } from "./discount-tools.js";
+export { taxTools, handleGetTaxGroup, handleCreateOrUpdateTaxGroup, handleDeleteTaxGroup, handleGetTaxMarkets, handleCreateOrUpdateTaxMarket, handleDeleteTaxMarket, } from "./tax-tools.js";

package/dist/tools/index.js

@@ -0,0 +1,39 @@
+/**
+ * BrinkCommerce MCP Tools
+ *
+ * This module exports all tool definitions and handlers for BrinkCommerce operations.
+ */
+// Export Product Management tools
+export { productTools, 
+// Product Parent handlers
+handleGetProductParent, handleCreateProductParent, handleDeleteProductParent, handlePatchProductParent, handleArchiveProductParent, 
+// Product Variant handlers
+handleGetProductVariant, handleListProductVariants, handleCreateProductVariant, handleDeleteProductVariant, handlePatchProductVariant, 
+// Addon handlers
+handleGetAddon, handleCreateOrUpdateAddon, handleDeleteAddon, handlePatchAddon, handleListProductParentAddons, handleAddProductParentAddon, handleRemoveProductParentAddon, } from "./product-tools.js";
+// Export Store Management tools
+export { storeTools, handleCreateOrUpdateStoreGroup, handleCreateOrUpdateStoreMarket, handleDeleteStoreGroup, handleDeleteStoreMarket, handleListStoreGroups, handleGetStoreGroup, handleListStoreMarkets, handlePatchStoreGroup, handlePatchStoreMarket, } from "./store-tools.js";
+// Export Stock Management tools
+export { stockTools, handleUpdateProductVariantInventory, handleDeleteProductVariantInventory, 
+// Inventory location handlers
+handleListInventories, handleGetInventory, handleCreateOrUpdateInventory, handleDeleteInventory, 
+// Product variant stock handlers
+handleGetProductVariantStock, handleUpdateProductVariantStockConfig, handlePatchProductVariantInventory, 
+// Store market inventories handlers
+handleGetStoreMarketInventories, handleUpdateStoreMarketInventories, } from "./stock-tools.js";
+// Export Price Management tools
+export { priceTools, handleUpdateProductVariantPrices, handleDeleteProductVariantPrices, handleGetProductVariantAllPrices, handleGetProductVariantPrices, handleGetProductVariantPrice, handleGetAddonPrice, handlePatchProductVariantPrices, } from "./price-tools.js";
+// Export Order Management tools
+export { orderTools, handleGetOrder, handleGetOrderByReference, handleCancelOrder, handleRefundOrder, handleImportOrder, handleGetImportedOrder, 
+// Delivery handlers
+handleCreateDelivery, handleGetDelivery, handleUpdateDelivery, handleDeleteDelivery, handleStartDelivery, handleRestartDelivery, 
+// Cancellation handlers
+handleGetCancellation, handleDeleteCancellation, handleStartCancellation, handleRestartCancellation, 
+// Refund handlers
+handleGetRefund, handleUpdateRefund, handleDeleteRefund, handleStartRefund, handleRestartRefund, 
+// Release handlers
+handleCreateRelease, handleGetRelease, handleDeleteRelease, handleStartRelease, handleRestartRelease, } from "./order-tools.js";
+// Export Discount Management tools
+export { discountTools, handleRunDiscounts, handleGetBundleGroup, handleCreateOrUpdateBundleGroup, handleDeleteBundleGroup, handleCreateDiscountCode, } from "./discount-tools.js";
+// Export Tax Management tools
+export { taxTools, handleGetTaxGroup, handleCreateOrUpdateTaxGroup, handleDeleteTaxGroup, handleGetTaxMarkets, handleCreateOrUpdateTaxMarket, handleDeleteTaxMarket, } from "./tax-tools.js";