MCP Server and Resource Metrics
- Server URL:
https://<domain>/promotion/mcp - Total Tools: 88
- Total Error Codes: 10
Server Overview
The MCP server provides a robust suite of 88 tools designed to manage promotions, collections, projects, and related functionalities, offering capabilities such as creation, retrieval, updates, validation, and deletion, while supporting advanced features like filtering, sorting, pagination, caching, and historical version tracking to streamline business operations and enhance promotional management efficiency.
Tools
The following table lists the available MCP tools for Promotions service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getRuleEngineModel | This tool provides the rule engine configuration and returns detailed responses based on status codes. |
|
|
| updateDroolsRule | This tool updates all Drools rules for a specified collection and provides detailed response codes and messages for various outcomes. |
|
|
| getPromoWallet | This tool retrieves a promowallet using a unique ID and provides detailed response codes, messages, timestamps, status, and failure reasons. |
|
|
| replacePromoWallet_1 | This tool updates the promowallet and its details based on a unique promocode ID, with various response codes indicating success or errors. |
|
|
| deletePromoWalletr | This tool performs a soft delete on an existing promowallet using a unique identifier, with various response codes indicating success or specific errors. |
|
|
| replacePromoCodeList | This tool updates specific attributes of a promowallet using a unique ID and provides detailed response codes for various outcomes. |
|
|
| getPromotionList | The tool loads a promotion list by ID and returns detailed response properties for various HTTP status codes. |
|
|
| replacePromotionList | The `updatePromotionList` tool updates a promotion list by ID, returning various response codes with detailed properties based on the operation’s outcome. |
|
|
| deletePromotionList | The tool deletes a promotion list by its unique ID and provides various response codes for success or errors, including details like status, timestamp, and failure reasons. |
|
|
| updatePromotionList | The tool updates a promotion list by ID, returning various response codes with details like status, timestamp, and failure reasons. |
|
|
| getPromoCodeList | This tool retrieves a promocode list using a unique ID and provides detailed response codes and messages for various outcomes. |
|
|
| replacePromoCodeList_1 | This tool updates the promocode list using a unique identifier and provides detailed responses for various status codes. |
|
|
| deletePromoCodeList | This tool deletes a promocode list by its unique ID, removing all associated promocodes. |
|
|
| replacePromoCodeList_1_2 | This tool updates specified attributes of a promocode list using a unique identifier and provides detailed response codes for various outcomes. |
|
|
| getProject | This tool retrieves a project by its unique ID and provides detailed response codes for various outcomes. |
|
|
| replaceProject | This tool updates all project attributes except ID and state, with detailed response codes and messages for various outcomes. |
|
|
| updateProject | This tool updates selected attributes of a project model using a unique project ID, returning various status codes and detailed response properties. |
|
|
| getPromotionGroup ByProjectId |
This tool retrieves a promotion group under a specified collection ID and project ID, returning status and error details in various response codes. |
|
|
| replacePromotionGroup | This tool updates an existing promotion group based on request data, with various response codes indicating success or specific errors. |
|
|
| clonePromotionGroup ByPromotionGroupId |
This tool duplicates a promotion group by creating an exact copy under a specified project ID. |
|
|
| deletePromotionGroup | This tool performs a soft delete on an existing promotion group using required project and group IDs, with detailed response codes for various statuses. |
|
|
| getPromotion ByPromotionGroupId |
This tool retrieves promotion details based on project, group, and promotion IDs, with various response codes indicating success or errors. |
|
|
| replacePromotion ByPromotionGroupId |
This tool updates an existing promotion based on provided request data and returns various response codes for success or errors. |
|
|
| clonePromotion ByPromotionGroupId |
This tool duplicates a promotion by creating an identical copy based on specified parameters and provides detailed response codes for various outcomes. |
|
|
| deletePromotion ByPromotionGroupId |
This tool performs a soft delete on an existing promotion using required project, group, and promotion IDs, with various response codes indicating success or errors. |
|
|
| getCollection | This tool retrieves a promotion collection using specified path and query parameters, returning status and details based on the operation’s outcome. |
|
|
| replaceCollection | This tool updates a promotion collection by modifying all attributes, requiring all associated properties to be included in the request. |
|
|
| replaceCollectionProperties | This tool updates collection properties based on provided identifiers and parameters, returning detailed response codes and messages for various outcomes. |
|
|
| updateCollectionProperties | This tool modifies a collection’s property by name using collection ID, requiring mandatory name and value attributes, with detailed response codes for various statuses. |
|
|
| refreshApi | This tool updates secret keys without a restart, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters with detailed response codes. |
|
None |
| getloadAllPromoWallet | This tool retrieves promowallets based on page requests, with sorting, filtering, pagination, and detailed response codes. |
|
|
| createPromoWallet | This tool generates a list of Promowallet with detailed response codes and messages for various statuses. |
|
|
| getPromotionLists | The tool retrieves promotion lists with sorting, filtering, pagination, and detailed response codes for various statuses. |
|
|
| createPromotionList | The tool provides various HTTP status codes with detailed response properties, including timestamps, status, and error details for promotion creation operations. |
|
|
| getPromoCodeLists | This tool retrieves paginated promocode lists with sorting, filtering, and detailed response codes for various statuses. |
|
|
| createPromoCodeList | This tool generates a list of promocodes and provides detailed response codes for success or failure scenarios. |
|
|
| getProjects | This tool retrieves all projects with optional sorting, filtering, pagination, and detailed response codes for various statuses. |
|
|
| createProject | This tool creates a new project and provides detailed response codes and messages for various outcomes. |
|
|
| getPromotionGroups ByProjectId |
This tool retrieves all promotion groups under a specified project ID, with optional filters, sorting, and pagination. |
|
|
| createPromotionGroup | This tool creates a promotion group using request data and provides detailed response codes for various outcomes. |
|
|
| getPromotions ByPromotionGroupId |
This tool retrieves all promotions within a specified promotion group using path and query parameters, with detailed response codes for success or errors. |
|
|
| createPromotion ByPromotionGroupId |
This tool creates a promotion using request data and provides detailed responses for success or various error scenarios. |
|
|
| unblockoOffer | This tool provides the unblocked confirmation code for a given promocode, with detailed response statuses and properties. |
|
|
| unassignOffer | This tool retrieves the unassigned confirmation code for a provided promocode, with detailed response statuses and properties. |
|
|
| getCustomOffers | This tool retrieves promotional offers, calculates discounts, and provides relevant messages and descriptions based on specified criteria. |
|
|
| getOffer | This tool retrieves promotional offers and messages for items matching specified criteria, with detailed response codes and statuses. |
|
|
| blockOffer | This tool retrieves blocked confirmation codes for a given promocode and provides detailed response properties for various status codes. |
|
|
| assignOffer | This tool provides a PromoOffertoolResponse model detailing assigned promocode information, with various response codes indicating success or errors. |
|
|
| applyOffer | This tool retrieves promotional offers, calculates discounts, and provides related messages and descriptions based on specified criteria. |
|
|
| cacheClear | This tool clears cached data based on specified cache names, supports string-type keys, and clears all cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and provides detailed response codes and messages for various status scenarios. |
|
|
| getCollections | This tool retrieves all promotion collections with support for filtering, sorting, pagination, and detailed response codes. |
|
|
| createCollection | This tool creates a promotion collection with default or updated properties, disallowing new ones, and provides detailed response codes for various statuses. |
|
|
| cacheClear_2 | This tool clears the promotion cache and provides detailed response codes for success or failure scenarios. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, cleans instance data, and uses `keyName` and `resetRequired` parameters with detailed response codes for various statuses. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS calls, and requires keyName and resetRequired parameters with detailed response codes. |
|
None |
| validateDroolsRule | This tool validates Drools rules in a collection, returning incorrect rules with error details for various response codes. |
|
|
| getAllStandrdRoles | This tool retrieves and filters standard roles with privileges but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service with detailed response codes and properties for various statuses. |
|
None |
| findPromotionListItemsById | This tool retrieves a promotion list based on a unique ID, with options for sorting, filtering, pagination, and detailed response codes. |
|
|
| downloadPromotionLists | The tool allows downloading promotion lists using a unique ID, with responses detailing status, timestamps, and error reasons across various HTTP codes. |
|
|
| getPromotions | This tool retrieves promotions with filtering, sorting, pagination, and detailed response codes for various statuses. |
|
|
| getLivePromotinoGroups | This tool retrieves all live promotion groups in the APPROVED state, with options for filtering, sorting, and pagination. |
|
|
| getLivePromotinoGroup | This tool retrieves an approved promotion group by its ID, providing detailed response codes and messages for various outcomes. |
|
|
| getLivePromotino GroupVersions |
This tool retrieves all versions of a promotion group, preserving its history by saving previous versions upon edits. |
|
|
| getLivePromotions | This tool retrieves all live promotions in the APPROVED state, with options for filtering, sorting, pagination, and detailed response codes. |
|
|
| getLivePromotion ByPromotionGroupId |
This tool retrieves a live promotion using a unique promotion ID and provides detailed response codes and messages for various outcomes. |
|
|
| getPromotionVersions | This tool retrieves all versions of a promotion, preserving its history and creating new versions upon edits, with detailed parameters and response codes for various scenarios. |
|
|
| getPromoCodeListItems | This tool retrieves a list of promocode items based on a unique ID, with optional sorting, filtering, pagination, and detailed response codes. |
|
|
| downloadPromoCodeLists | This tool downloads a promocode list based on a required unique ID, providing detailed response properties for various status codes. |
|
|
| getPromoCodeLists_1 | This tool retrieves promocode list items based on a specified list ID and supports pagination with detailed response codes. |
|
|
| getPromotionsByProjectId | This tool retrieves all promotions under a specified project using parameters for filtering, sorting, and pagination. |
|
|
| findAllPromotion GroupNamesByIds |
This tool retrieves promotion group names based on provided project and group IDs, returning status and error details for various response codes. |
|
|
| getProjects_1 | The tool operation retrieves project details based on a unique group ID, returning various response codes with associated properties for success, errors, or default cases. |
|
|
| getProjects_2 | This tool loads all projects based on a unique promotion ID and provides detailed responses for various status codes. |
|
|
| getAllPrivileges | This tool retrieves service privileges from `roles_privileges.json` and provides detailed responses for various status codes. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter, with detailed response codes for various statuses. |
|
|
| testPing | This tool provides the current timestamp to check the operational status of the promotion service. |
|
None |
| getPromoCodeUsageCount | This tool provides the usage count of a promocode with detailed response codes and messages for various statuses. |
|
|
| getCacheValue | This tool retrieves cached data for a specified service using string-based cache name and key, with various response codes for success or errors. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’, with detailed response codes and messages for various statuses. |
|
None |
| getCollection PropertyByName |
This tool retrieves a collection property by name using specified identifiers and parameters, returning detailed response codes and messages. |
|
|
| getPromotion PropertyByName |
This tool retrieves a collection’s properties by name using a valid identifier and optional locale, with detailed response codes for various statuses. |
|
|
| getCollectionProperties | This tool retrieves collection properties by name using specified query parameters and provides detailed response codes for various outcomes. |
|
|
| getPromotionChangeLog | This tool retrieves change logs within a specified time range, supporting filters, sorting, pagination, and detailed response codes. |
|
|
| getPromotion RedemptionByUserId |
This tool retrieves a user’s Promotion Redemption data, including redemption counts and optional archived promotions, with detailed response codes and statuses. |
|
|
| clearPromotionList | The tool clears a promotion list by ID, returning various status codes and detailed response properties for success or errors. |
|
|
| clearPromoCodeList | This tool clears items from a promocode list using its unique ID while retaining list details, with various response codes indicating success or errors. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): OK |
| 201 | (Success): Created |
| 204 | (Success): No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict |
| 422 | Unprocessable Entity |
| 500 | Internal Server Error |
Useful Resources
- API Specifications: API Endpoints – Promotions
- Services Details: Promotions Service
- Video: Infosys Equinox: Promotions MCP Demo
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added