@unchainedshop/api 4.0.0-rc.2 → 4.0.0-rc.4

package/src/mcp/index.ts

@@ -0,0 +1,718 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { Context } from '../context.js';
+import {
+  listProductsHandler,
+  ListProductsSchema,
+  getProductHandler,
+  GetProductSchema,
+  createProductHandler,
+  CreateProductSchema,
+  RemoveProductSchema,
+  removeProductHandler,
+  PublishProductSchema,
+  publishProductHandler,
+  UnpublishProductSchema,
+  unpublishProductHandler,
+  UpdateProductSchema,
+  updateProductHandler,
+  UpdateProductTextsSchema,
+  updateProductTextsHandler,
+  UpdateProductCommerceSchema,
+  updateProductCommerceHandler,
+  ListCurrenciesSchema,
+  currenciesHandler,
+  CurrencySchema,
+  currencyHandler,
+  ListCountriesSchema,
+  countriesHandler,
+  CountrySchema,
+  countryHandler,
+  ListLanguagesSchema,
+  languagesHandler,
+  LanguageSchema,
+  languageHandler,
+  UpdateProductSupplySchema,
+  updateProductSupplyHandler,
+  UpdateProductPlanSchema,
+  updateProductPlanHandler,
+  UpdateProductTokenizationSchema,
+  updateProductTokenizationHandler,
+  ProductsCountSchema,
+  productsCountHandler,
+  CreateProductVariationSchema,
+  createProductVariationHandler,
+  RemoveProductVariationSchema,
+  removeProductVariationHandler,
+  AssignProductVariationSchema,
+  addProductAssignmentHandler,
+  CreateProductVariationOptionSchema,
+  createProductVariationOptionHandler,
+  removeProductAssignmentHandler,
+  RemoveProductVariationOptionSchema,
+  removeProductVariationOptionHandler,
+  RemoveProductAssignmentSchema,
+  CreateLanguageSchema,
+  createLanguageHandler,
+  UpdateLanguageSchema,
+  updateLanguageHandler,
+  RemoveLanguageSchema,
+  removeLanguageHandler,
+  AddProductMediaUploadSchema,
+  addProductMediaUploadHandler,
+  RemoveProductMediaSchema,
+  removeProductMediaHandler,
+  UpdateProductMediaTextsSchema,
+  updateProductMediaTextsHandler,
+  ReorderProductMediaSchema,
+  reorderProductMediaHandler,
+  ProductReviewsCountSchema,
+  productReviewsCountHandler,
+  ProductReviewsSchema,
+  productReviewsHandler,
+  TranslatedProductTextsSchema,
+  translatedProductTextsHandler,
+  TranslatedProductMediaTextsSchema,
+  translatedProductMediaTextsHandler,
+  TranslatedProductVariationTextsSchema,
+  translatedProductVariationTextsHandler,
+  shopInfoHandler,
+  CreateCountrySchema,
+  createCountryHandler,
+  UpdateCountrySchema,
+  updateCountryHandler,
+  RemoveCountrySchema,
+  removeCountryHandler,
+  CountriesCountSchema,
+  countriesCountHandler,
+  CreateCurrencySchema,
+  createCurrencyHandler,
+  UpdateCurrencySchema,
+  updateCurrencyHandler,
+  RemoveCurrencySchema,
+  removeCurrencyHandler,
+  CurrenciesCountSchema,
+  currenciesCountHandler,
+  LanguagesCountSchema,
+  languagesCountHandler,
+  CreateAssortmentSchema,
+  createAssortmentHandler,
+  AssortmentsSchema,
+  assortmentsHandler,
+  AssortmentsCountSchema,
+  assortmentsCountHandler,
+  AssortmentSchema,
+  assortmentHandler,
+  UpdateAssortmentSchema,
+  updateAssortmentHandler,
+  RemoveAssortmentSchema,
+  removeAssortmentHandler,
+  SetBaseAssortmentSchema,
+  setBaseAssortmentHandler,
+  AssortmentChildrenSchema,
+  assortmentChildrenHandler,
+  assortmentProductsHandler,
+  AssortmentProductsSchema,
+  searchAssortmentProductHandler,
+  SearchAssortmentProductSchema,
+  AssortmentLinksSchema,
+  assortmentLinksHandler,
+  AssortmentFiltersSchema,
+  assortmentFiltersHandler,
+  AddAssortmentProductSchema,
+  addAssortmentProductHandler,
+  RemoveAssortmentProductSchema,
+  removeAssortmentProductHandler,
+  ReorderAssortmentProductsSchema,
+  reorderAssortmentProductsHandler,
+  AddAssortmentLinkSchema,
+  addAssortmentLinkHandler,
+  RemoveAssortmentLinkSchema,
+  removeAssortmentLinkHandler,
+  ReorderAssortmentMediaSchema,
+  reorderAssortmentMediaHandler,
+  RemoveAssortmentMediaSchema,
+  removeAssortmentMediaHandler,
+  AddAssortmentMediaUploadSchema,
+  addAssortmentMediaUploadHandler,
+  CreateFilterSchema,
+  createFilterHandler,
+  UpdateFilterSchema,
+  updateFilterHandler,
+  RemoveFilterSchema,
+  removeFilterHandler,
+  CreateFilterOptionSchema,
+  createFilterOptionHandler,
+  UpdateFilterTextsSchema,
+  updateFilterTextsHandler,
+  RemoveFilterOptionSchema,
+  removeFilterOptionHandler,
+  GetFilterSchema,
+  getFilterHandler,
+  GetFiltersSchema,
+  getFiltersHandler,
+  TranslatedFilterTextsSchema,
+  translatedFilterTextsHandler,
+  TranslatedAssortmentMediaTextsSchema,
+  translatedAssortmentMediaTextsHandler,
+  TranslatedAssortmentTextsSchema,
+  translatedAssortmentTextsHandler,
+  AddAssortmentFilterSchema,
+  addAssortmentFilterHandler,
+  RemoveAssortmentFilterSchema,
+  removeAssortmentFilterHandler,
+  ReorderAssortmentFiltersSchema,
+  reorderAssortmentFiltersHandler,
+} from './tools/index.js';
+
+export default function createMcpServer(context: Context, roles) {
+  const server = new McpServer({
+    name: 'Unchained MCP Server',
+    version: '1.0.0',
+  });
+
+  if (!roles?.includes('admin')) {
+    return server;
+  }
+
+  server.tool(
+    'list_products',
+    `Search and list products with comprehensive filtering, sorting, and pagination support.`,
+    ListProductsSchema,
+    async (params) => listProductsHandler(context, params),
+  );
+
+  server.tool(
+    'products_count',
+    'Search and returns total number of products registered in the system with comprehensive filtering if provided',
+    ProductsCountSchema,
+    async (params) => productsCountHandler(context, params),
+  );
+  server.tool('get_product', 'Get detailed product information', GetProductSchema, async (params) =>
+    getProductHandler(context, params),
+  );
+
+  server.tool(
+    'create_product',
+    'Adds or create new product the product will be in DRAFT/unpublish status',
+    CreateProductSchema,
+    async (params) => createProductHandler(context, params),
+  );
+  server.tool(
+    'remove_product',
+    'Removed or deletes a product by its id changing its status to DELETED and removing it from sale',
+    RemoveProductSchema,
+    async (params) => removeProductHandler(context, params),
+  );
+
+  server.tool(
+    'publish_product',
+    'Publish a product by its id changing it to active and available for sale',
+    PublishProductSchema,
+    async (params) => publishProductHandler(context, params),
+  );
+
+  server.tool(
+    'unpublish_product',
+    'Deactivates or Unpublishes product by its id changing it to DRAFT and not available for sale',
+    UnpublishProductSchema,
+    async (params) => unpublishProductHandler(context, params),
+  );
+  server.tool(
+    'update_product',
+    'Modify/Update generic infos of a product (tags for ex.)',
+    UpdateProductSchema,
+    async (params) => updateProductHandler(context, params),
+  );
+
+  server.tool(
+    'update_product_texts',
+    'Modify/update localized texts of a product',
+    UpdateProductTextsSchema,
+    async (params) => updateProductTextsHandler(context, params),
+  );
+
+  server.tool(
+    'update_product_commerce',
+    'Modify/update products commerce info like prices, taxes, etc. for all product types except CONFIGURABLE_PRODUCT. for currency value always use registered currency in the system and not a custom one, it should not be called for CONFIGURABLE_PRODUCT type products',
+    UpdateProductCommerceSchema,
+    async (params) => updateProductCommerceHandler(context, params),
+  );
+
+  server.tool(
+    'update_product_warehousing',
+    'Modify/update products commerce info like prices, taxes, etc. for SIMPLE_PRODUCT product type only.  it is only available for SIMPLE_PRODUCT type products',
+    UpdateProductCommerceSchema,
+    async (params) => updateProductCommerceHandler(context, params),
+  );
+
+  server.tool(
+    'update_product_supply',
+    'Modify/update products supply of SIMPLE_PRODUCT type info like prices, taxes, etc. it is only available for SIMPLE_PRODUCT type products',
+    UpdateProductSupplySchema,
+    async (params) => updateProductSupplyHandler(context, params),
+  );
+  server.tool(
+    'update_tokenized_product',
+    'Modify/update products supply of TOKENIZED_PRODUCT type info like contractAddress, contractStandard, tokenId, supply, ercMetadataProperties etc. it is only available for TOKENIZED_PRODUCT type products',
+    UpdateProductTokenizationSchema,
+    async (params) => updateProductTokenizationHandler(context, params),
+  );
+  server.tool(
+    'update_product_plan',
+    'Modify/update products subscription/plan information of PLAN_PRODUCT type info like billing period, trial period and usage calculation, etc. it is only available for PLAN_PRODUCT type products',
+    UpdateProductPlanSchema,
+    async (params) => updateProductPlanHandler(context, params),
+  );
+
+  server.tool(
+    'list_currencies',
+    'List all available currencies in the system, if non existing currency is provided to you by a user inform them it does not exist and to create it first before they can use it',
+    ListCurrenciesSchema,
+    async (params) => currenciesHandler(context, params),
+  );
+
+  server.tool(
+    'get_currency',
+    'Gets a single currency registered in the system',
+    CurrencySchema,
+    async (params) => currencyHandler(context, params),
+  );
+
+  server.tool(
+    'list_countries',
+    'List all available countries in the system, if non existing country is provided to you by a user inform them it does not exist and to create it first before they can use it',
+    ListCountriesSchema,
+    async (params) => countriesHandler(context, params),
+  );
+
+  server.tool(
+    'get_country',
+    'Gets a single country registered in the system',
+    CountrySchema,
+    async (params) => countryHandler(context, params),
+  );
+
+  server.tool(
+    'list_languages',
+    'List all available languages in the system, if non existing language is provided to you by a user inform them it does not exist and to create it first before they can use it',
+    ListLanguagesSchema,
+    async (params) => languagesHandler(context, params),
+  );
+
+  server.tool(
+    'get_language',
+    'Gets a single language registered in the system',
+    LanguageSchema,
+    async (params) => languageHandler(context, params),
+  );
+
+  server.tool(
+    'create_product_variation',
+    'Adds/create a variation of a product, it is only available for CONFIGURABLE_PRODUCT type products',
+    CreateProductVariationSchema,
+    async (params) => createProductVariationHandler(context, params),
+  );
+
+  server.tool(
+    'remove_product_variation',
+    'removes a variation of a product',
+    RemoveProductVariationSchema,
+    async (params) => removeProductVariationHandler(context, params),
+  );
+
+  server.tool(
+    'assign_product_variation',
+    'Link a product to a ConfigurableProduct variation option by providing a vector combination that uniquely identifies the variation option',
+    AssignProductVariationSchema,
+    async (params) => addProductAssignmentHandler(context, params),
+  );
+
+  server.tool(
+    'add_variation_options',
+    'Adds variation option to an existing product variations',
+    CreateProductVariationOptionSchema,
+    async (params) => createProductVariationOptionHandler(context, params),
+  );
+
+  server.tool(
+    'remove_variation_options',
+    'Removes product option value for product variation with the provided variation option value',
+    RemoveProductVariationOptionSchema,
+    async (params) => removeProductVariationOptionHandler(context, params),
+  );
+
+  server.tool(
+    'remove_product_variation_assignment',
+    'Unlinks a product from a ConfigurableProduct by providing a configuration combination that uniquely identifies a row in the assignment matrix',
+    RemoveProductAssignmentSchema,
+    async (params) => removeProductAssignmentHandler(context, params),
+  );
+
+  server.tool('add_language', 'Adds new language', CreateLanguageSchema, async (params) =>
+    createLanguageHandler(context, params),
+  );
+
+  server.tool('update_language', 'Updates language', UpdateLanguageSchema, async (params) =>
+    updateLanguageHandler(context, params),
+  );
+
+  server.tool('remove_language', 'Deletes a language', RemoveLanguageSchema, async (params) =>
+    removeLanguageHandler(context, params),
+  );
+
+  server.tool(
+    'add_product_media',
+    'Adds media to a product',
+    AddProductMediaUploadSchema,
+    async (params) => addProductMediaUploadHandler(context, params),
+  );
+
+  server.tool(
+    'remove_product_media',
+    "Remove a media asset from a product's visualization",
+    RemoveProductMediaSchema,
+    async (params) => removeProductMediaHandler(context, params),
+  );
+
+  server.tool(
+    'update_product_media_texts',
+    "Modify localized texts part of a product's media asset",
+    UpdateProductMediaTextsSchema,
+    async (params) => updateProductMediaTextsHandler(context, params),
+  );
+
+  server.tool(
+    'reorder_product_media',
+    'Reorder a media asset (first is primary)',
+    ReorderProductMediaSchema,
+    async (params) => reorderProductMediaHandler(context, params),
+  );
+
+  server.tool(
+    'product_review_count',
+    'Returns total number of product reviews',
+    ProductReviewsCountSchema,
+    async (params) => productReviewsCountHandler(context, params),
+  );
+
+  server.tool(
+    'product_reviews',
+    'Get all product reviews, by default sorted by creation date (descending)',
+    ProductReviewsSchema,
+    async (params) => productReviewsHandler(context, params),
+  );
+  server.tool(
+    'product_localized_texts',
+    'Returns Localization: Meta data for product',
+    TranslatedProductTextsSchema,
+    async (params) => translatedProductTextsHandler(context, params),
+  );
+
+  server.tool(
+    'product_media_localized_texts',
+    'Returns Localization: Meta data for product media',
+    TranslatedProductMediaTextsSchema,
+    async (params) => translatedProductMediaTextsHandler(context, params),
+  );
+
+  server.tool(
+    'product_variation_localized_texts',
+    'Returns Localization: Meta data for product variation',
+    TranslatedProductVariationTextsSchema,
+    async (params) => translatedProductVariationTextsHandler(context, params),
+  );
+  server.tool(
+    'shop_info',
+    'Get the default configuration of the shop including country, language, currency, and locale. If the user does not provide values such as language, locale, country, or currency in their request or it cannot be derived from context, the tool MUST use the following fallback values : - language or locale: use defaultLanguageIsoCode  - country: use country.isoCode - currency: use country.defaultCurrency Always assume these values as the authoritative defaults when user input is missing or ambiguous.',
+    {},
+    async () => shopInfoHandler(context),
+  );
+
+  server.tool(
+    'add_country',
+    'Adds new country information to the system',
+    CreateCountrySchema,
+    async (params) => createCountryHandler(context, params),
+  );
+
+  server.tool(
+    'update_country',
+    'Updates provided country information',
+    UpdateCountrySchema,
+    async (params) => updateCountryHandler(context, params),
+  );
+
+  server.tool('delete_country', 'Deletes the specified country', RemoveCountrySchema, async (params) =>
+    removeCountryHandler(context, params),
+  );
+
+  server.tool(
+    'countries_count',
+    'Returns total number of countries registered in the system',
+    CountriesCountSchema,
+    async (params) => countriesCountHandler(context, params),
+  );
+
+  server.tool(
+    'add_currency',
+    'Adds new currency information to the system',
+    CreateCurrencySchema,
+    async (params) => createCurrencyHandler(context, params),
+  );
+  server.tool(
+    'update_currency',
+    'Updates the specified currency in the system',
+    UpdateCurrencySchema,
+    async (params) => updateCurrencyHandler(context, params),
+  );
+
+  server.tool(
+    'delete_currency',
+    'Deletes the specified currency from the system',
+    RemoveCurrencySchema,
+    async (params) => removeCurrencyHandler(context, params),
+  );
+
+  server.tool(
+    'currencies_count',
+    'Returns total number of currencies registered in the system',
+    CurrenciesCountSchema,
+    async (params) => currenciesCountHandler(context, params),
+  );
+
+  server.tool(
+    'languages_count',
+    'Returns total number of languages registered in the system',
+    LanguagesCountSchema,
+    async (params) => languagesCountHandler(context, params),
+  );
+
+  server.tool('add_assortment', 'Creates new assortment', CreateAssortmentSchema, async (params) =>
+    createAssortmentHandler(context, params),
+  );
+
+  server.tool(
+    'update_assortment',
+    'Updates the details of an existing assortment such as tags, active state, root status, or sort order.',
+    UpdateAssortmentSchema,
+    async (params) => updateAssortmentHandler(context, params),
+  );
+
+  server.tool(
+    'delete_assortment',
+    'Removes assortment with the provided ID',
+    RemoveAssortmentSchema,
+    async (params) => removeAssortmentHandler(context, params),
+  );
+
+  server.tool(
+    'set_assortment_base',
+    'Makes the assortment provided as the base assortment and make any other existing base assortment regular assortments.',
+    SetBaseAssortmentSchema,
+    async (params) => setBaseAssortmentHandler(context, params),
+  );
+
+  server.tool(
+    'get_assortment',
+    'Get a specific assortment by ID or slug',
+    AssortmentSchema,
+    async (params) => assortmentHandler(context, params),
+  );
+
+  server.tool(
+    'list_assortments',
+    'Search and list assortments with comprehensive filtering, sorting, and pagination support.',
+    AssortmentsSchema,
+    async (params) => assortmentsHandler(context, params),
+  );
+
+  server.tool(
+    'assortments_count',
+    'Returns total number of assortments that match a given criteria or all if no criteria is given',
+    AssortmentsCountSchema,
+    async (params) => assortmentsCountHandler(context, params),
+  );
+
+  server.tool(
+    'assortment_children',
+    'Returns child assortments of the specified assortmentID',
+    AssortmentChildrenSchema,
+    async (params) => assortmentChildrenHandler(context, params),
+  );
+
+  server.tool(
+    'assortment_products',
+    'Returns products assigned to the specified assortmentID',
+    AssortmentProductsSchema,
+    async (params) => assortmentProductsHandler(context, params),
+  );
+
+  server.tool(
+    'search_assortment_products',
+    'searches products assigned to the specified assortment using various parameters',
+    SearchAssortmentProductSchema,
+    async (params) => searchAssortmentProductHandler(context, params),
+  );
+
+  server.tool(
+    'assortment_links',
+    'return all the linked assortment of the specified assortment ID including all hierarchy',
+    AssortmentLinksSchema,
+    async (params) => assortmentLinksHandler(context, params),
+  );
+
+  server.tool(
+    'assortment_filters',
+    'Returns filters assigned to the specified assortmentID',
+    AssortmentFiltersSchema,
+    async (params) => assortmentFiltersHandler(context, params),
+  );
+
+  server.tool(
+    'add_assortment_product',
+    'Add a new product to an assortment',
+    AddAssortmentProductSchema,
+    async (params) => addAssortmentProductHandler(context, params),
+  );
+
+  server.tool(
+    'remove_assortment_product',
+    'Remove a product from an assortment',
+    RemoveAssortmentProductSchema,
+    async (params) => removeAssortmentProductHandler(context, params),
+  );
+
+  server.tool(
+    'reorder_assortment_products',
+    'Reorder sort sequence of products in an assortment',
+    ReorderAssortmentProductsSchema,
+    async (params) => reorderAssortmentProductsHandler(context, params),
+  );
+
+  server.tool(
+    'add_assortment_link',
+    'Add a new child assortment to an assortment',
+    AddAssortmentLinkSchema,
+    async (params) => addAssortmentLinkHandler(context, params),
+  );
+
+  server.tool(
+    'remove_assortment_link',
+    `Removes a child/parent assortment link from it's parent`,
+    RemoveAssortmentLinkSchema,
+    async (params) => removeAssortmentLinkHandler(context, params),
+  );
+
+  server.tool(
+    'reorder_assortment_links',
+    ` Reorders the assortment links in parent assortment`,
+    RemoveAssortmentLinkSchema,
+    async (params) => removeAssortmentLinkHandler(context, params),
+  );
+
+  server.tool(
+    'reorder_assortment_medias',
+    `Reorders the assortment medias`,
+    ReorderAssortmentMediaSchema,
+    async (params) => reorderAssortmentMediaHandler(context, params),
+  );
+
+  server.tool(
+    'add_assortment_media',
+    `Add a media asset to a assortment`,
+    RemoveAssortmentMediaSchema,
+    async (params) => removeAssortmentMediaHandler(context, params),
+  );
+  server.tool(
+    'remove_assortment_media',
+    `Remove a media asset from a assortment`,
+    AddAssortmentMediaUploadSchema,
+    async (params) => addAssortmentMediaUploadHandler(context, params),
+  );
+
+  server.tool('add_filter', `Creates new Filter`, CreateFilterSchema, async (params) =>
+    createFilterHandler(context, params),
+  );
+  server.tool('update_filter', `Update filter information`, UpdateFilterSchema, async (params) =>
+    updateFilterHandler(context, params),
+  );
+
+  server.tool('remove_filter', ` Deletes the specified filter`, RemoveFilterSchema, async (params) =>
+    removeFilterHandler(context, params),
+  );
+  server.tool(
+    'add_filter_option',
+    `Adds new option to filters`,
+    CreateFilterOptionSchema,
+    async (params) => createFilterOptionHandler(context, params),
+  );
+
+  server.tool(
+    'update_filter_texts',
+    `Updates or created specified filter texts for filter with ID provided and locale and optionally filterOptionValue`,
+    UpdateFilterTextsSchema,
+    async (params) => updateFilterTextsHandler(context, params),
+  );
+
+  server.tool(
+    'remove_filter_option',
+    `Removes the filter option from the specified filter.`,
+    RemoveFilterOptionSchema,
+    async (params) => removeFilterOptionHandler(context, params),
+  );
+
+  server.tool('get_filter', `Get a specific filter by ID`, GetFilterSchema, async (params) =>
+    getFilterHandler(context, params),
+  );
+
+  server.tool(
+    'list_filters',
+    `Get all filters, by default sorted by creation date (ascending), optionally it can filter based on various parameters including querystring`,
+    GetFiltersSchema,
+    async (params) => getFiltersHandler(context, params),
+  );
+
+  server.tool(
+    'filter_localized_texts',
+    `Returns localized filter texts found in the system for the specified filterId`,
+    TranslatedFilterTextsSchema,
+    async (params) => translatedFilterTextsHandler(context, params),
+  );
+
+  server.tool(
+    'assortment_media_localized_texts',
+    'Returns localized assortment media texts found in the system for the specified assortmentId',
+    TranslatedAssortmentMediaTextsSchema,
+    async (params) => translatedAssortmentMediaTextsHandler(context, params),
+  );
+
+  server.tool(
+    'assortment_localized_texts',
+    'Returns localized assortment texts found in the system for the specified assortmentId',
+    TranslatedAssortmentTextsSchema,
+    async (params) => translatedAssortmentTextsHandler(context, params),
+  );
+
+  server.tool(
+    'add_assortment_filter',
+    'Add/attach/link a filter to an assortment',
+    AddAssortmentFilterSchema,
+    async (params) => addAssortmentFilterHandler(context, params),
+  );
+
+  server.tool(
+    'remove_assortment_filter',
+    'Removes/unlinks a filter from assortment',
+    RemoveAssortmentFilterSchema,
+    async (params) => removeAssortmentFilterHandler(context, params),
+  );
+
+  server.tool(
+    'reorder_assortment_filters',
+    'Reorders the assortment filters',
+    ReorderAssortmentFiltersSchema,
+    async (params) => reorderAssortmentFiltersHandler(context, params),
+  );
+
+  return server;
+}