MCP Server and Resource Metrics
- Server URL:
https://<domain>/loyalty/mcp - Total Tools: 59
- Total Error Codes: 11
Server Overview
The MCP server provides a robust suite of 59 tools designed to manage and optimize rule engines, loyalty programs, collections, campaigns, transactions, caching, and privileges, offering comprehensive solutions for business automation, data handling, and operational efficiency.
Tools
The following table lists the available MCP tools for Loyalty service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getRuleEngineModel | This tool retrieves the rule engine configuration based on provided query parameters and returns detailed responses for various statuses. |
|
|
| updateDroolsRule | This tool updates Drools rules for a specified collection, with various response codes indicating success or errors. |
|
|
| getRuleSetById | This tool loads a rule set using a unique ID, supports locale-based responses, and provides detailed success or error information. |
|
|
| replaceRuleSet | This tool updates an existing rule set based on request data, with responses indicating success or various error conditions. |
|
|
| deleteRuleSet | This tool deletes a rule set based on the provided identifier and supports various response codes for success or errors. |
|
|
| getRuleByRuleId | This tool loads a rule using specified path and query parameters, returning responses based on success or error conditions. |
|
|
| replaceRuleByRuleSetId | This tool updates a rule within a specified rule set and provides detailed responses for various outcomes. |
|
|
| deleteRuleByRuleSetId | This tool deletes an existing rule based on request data, requiring `ruleSetId` and `ruleId` as path parameters, with various response codes indicating success or errors. |
|
|
| getRewardBank | This tool fetches Rewards Bank details (ACTIVE or INACTIVE) using collection ID and user ID, with customizable query parameters and detailed response formats. |
|
|
| replaceRewardBank | This tool updates all fields in the Rewards Bank based on the provided LoyaltyRequest object and returns detailed responses for success or various error scenarios. |
|
|
| updateRewardBank | This tool updates specified fields in a Rewards Bank based on the provided request object and returns responses for success or various error conditions. |
|
|
| getLoyaltyEvent | This tool retrieves event details using event and collection identifiers, with responses based on status codes. |
|
|
| putUpdateLoyaltyEvent | This tool updates an event using its unique identifier and collection ID, with responses ranging from success to various error codes. |
|
|
| deleteLoyaltyEvent | This tool deletes an event using event and collection identifiers, with options for locale and permanent deletion, returning various status codes and error details. |
|
|
| updateLoyaltyEvent | This tool updates event fields using event and collection identifiers, with responses ranging from success to various error codes. |
|
|
| getCollection | This tool retrieves a collection’s details using its unique collection ID and associated parameters. |
|
|
| replaceCollection | This tool updates all fields in a collection based on the provided request, using path and query parameters for identification and configuration. |
|
|
| replaceCollectionProperties | This tool updates all properties of a specified collection within a microservice, with responses based on operation success or errors. |
|
|
| updateCollectionProperties | This tool updates properties of an existing collection within a microservice based on provided identifiers and parameters. |
|
|
| getTransactions | This tool retrieves all transactions of a loyalty collection, supports filtering, sorting, pagination, and returns detailed responses for various statuses. |
|
|
| createTransaction | This tool facilitates transaction creation with detailed parameters and response handling. |
|
|
| refreshApi | This tool updates secret keys without restart, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| getAllRuleSets | This tool retrieves all rule sets with support for filtering, sorting, pagination, and detailed response/error handling. |
|
|
| createRuleSet | This tool creates a rule set with detailed response properties and error handling codes. |
|
|
| getRulesByRuleSetId | This tool retrieves all rules based on specified parameters and returns responses for various statuses. |
|
|
| createRuleByRuleSetId | This tool creates a rule using specified parameters and provides detailed responses for various outcomes. |
|
|
| findAllRewards | This tool retrieves rewards for a collection based on filters, pagination, and sorting parameters, with detailed response codes and examples. |
|
|
| createLoyaltyReward | This tool creates a reward within a collection, with locale-based responses and detailed error handling. |
|
|
| getRewardsBanks | This tool retrieves all Rewards Banks (ACTIVE or INACTIVE) from a specified collection with support for filtering, sorting, pagination, and locale-based responses. |
|
|
| createRewardBank | This tool creates a Rewards Bank based on the provided request and returns detailed responses for success or errors. |
|
|
| getLoyaltyRewards | This tool retrieves reward values for items matching rule-based criteria, with responses detailing rewards, errors, or statuses. |
|
|
| getLoyaltyEvents | This tool retrieves events from a collection based on filters, pagination, sorting, and locale parameters, returning results or error codes. |
|
|
| createLoyaltyEvent | This tool creates an event within a collection, supports locale customization, and provides detailed success or error responses. |
|
|
| cacheClear | This tool clears cached data by cache name(s), supports string-type keys, and provides detailed response codes for success or errors. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and provides detailed response codes and messages for various statuses. |
|
|
| getCollections | This tool retrieves collections with query parameters for filtering, pagination, sorting, and locale, returning detailed responses based on the request’s success or error status. |
|
|
| createCollection | This tool creates a collection based on the provided collection request and returns detailed responses for success or various error conditions. |
|
|
| getCampaigns | This tool retrieves campaigns from a collection based on filters, pagination, sorting, and locale settings, with detailed response codes for success or errors. |
|
|
| createCampaign | This tool creates a campaign under a collection, with detailed response codes and properties for success or errors. |
|
|
| processLoyaltyDiscount | This tool calculates loyalty discounts for a cart using the storefront orchestration service and provides detailed error responses. |
|
|
| cacheClear_2 | This tool clears cached data using specified parameters and provides detailed response codes for various outcomes. |
|
|
| findLoyaltyReward | This tool retrieves reward details using a reward and collection identifier, with responses based on success or error codes. |
|
|
| deleteLoyaltyReward | This tool deletes a reward using its unique identifier and collection identifier, with options for locale and permanent deletion. |
|
|
| updateLoyaltyReward | This tool updates reward fields using a reward and collection identifier, with responses indicating success or various errors. |
|
|
| getCampaign | This tool retrieves campaign details based on collection and campaign identifiers, with various response codes for success or errors. |
|
|
| updateCampaign | This tool updates campaign fields based on provided campaign and collection identifiers, with detailed responses for success or errors. |
|
|
| getTransaction | This tool retrieves transaction details using a unique transaction ID and provides responses based on success or error scenarios. |
|
|
| refreshApi_1 | This tool updates secret keys without a restart, cleans instance data for AWS calls, and uses `keyName` and `resetRequired` parameters with detailed response codes. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, cleans 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 or appropriate error responses. |
|
|
| getAllStandrdRoles | This tool retrieves and filters standard roles and privileges but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service and provides detailed response codes and messages for various statuses. |
|
None |
| getAllPrivileges | This tool retrieves service privileges from `roles_privileges.json` and provides various response codes for success or errors. |
|
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 outcomes. |
|
|
| getLoyalties | This tool provides the current timestamp to check the operational status of the Loyalty service, with various response codes indicating success or errors. |
|
None |
| getCacheValue | This tool retrieves cached data for a service using a string-based cache name and key, with various response codes indicating success or errors. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service based on a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionPropertiesByName | This tool retrieves a collection property based on the provided identifiers and parameters. |
|
|
| getCollectionAttributes | This tool retrieves all collection attributes with detailed response codes and descriptions for various outcomes. |
|
|
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 |
| 202 | (Success): Accepted |
| 204 | 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 – Loyalty
- Services Details: Loyalty Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added