MCP Server and Resource Metrics
- Server URL:
https://<domain>/list/mcp - Total Tools: 41
- Total Error Codes: 11
Server Overview
The MCP server provides robust tools for managing lists, collections, caching, and user privileges, enabling seamless data updates, retrieval, and synchronization across microservices with error handling and structured responses for diverse business needs.
Tools
The following table lists the available MCP tools for Lists service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| replacePropertiesByListId | This tool updates existing property values in a list, requires valid IDs, and returns various responses based on success or errors. |
|
|
| createPropertiesByListId | This tool adds extra properties to a list based on item and collection IDs, throwing errors for invalid or missing IDs, and supports various response statuses. |
|
|
| replacePropertyByListIdAndItemId | This tool updates or creates item properties by IDs, throws errors for invalid inputs, and provides responses in various HTTP status codes. |
|
|
| createPropertiesByListIdAndItemId | This tool adds extra properties to an item based on valid IDs, throwing errors for missing or invalid inputs, and provides various response codes for success or failure scenarios. |
|
|
| listenEvent | This tool merges a guest user’s list with a registered user’s list via the default exchange, supporting locale-specific responses. |
|
|
| getCollectionById | This tool retrieves collection details based on business ID and collection ID, throwing an error if required parameters are missing. |
|
|
| replaceCollectionById | This tool updates collection properties based on business and collection IDs, requiring a mandatory field name in the request, with various response codes indicating success or errors. |
|
|
| replacePropertiesByCollectionId | This tool updates collection properties, requiring a mandatory field name and valid identifiers, with detailed responses for various status codes. |
|
|
| updatePropertiesByCollectionId | This tool patch updates collection properties, requiring a mandatory field name, and provides responses for various status codes. |
|
|
| refreshApi | This tool updates secret keys without a restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters. |
|
None |
| getLists | This tool retrieves lists by collection ID with filters, supports pagination, sorting, and locale, and returns appropriate error codes for invalid inputs. |
|
|
| createList | This tool creates unique lists for a user within a collection, supports configurable list types, and handles errors for invalid or missing mandatory fields. |
|
|
| getListItemsByListId | This tool retrieves items linked to a list and collection ID, with pagination, sorting, filtering, and locale options, throwing errors for invalid inputs. |
|
|
| createListItemsByListId | This tool adds items (bundle or normal SKU) to a specified list using list ID and collection ID, returning errors for invalid inputs. |
|
|
| cacheClear | This tool clears cached data for specified cache names, supports string-type keys, and clears entire cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and provides a JSON response with a code, message, and timestamp. |
|
|
| getCollections | This tool retrieves collections based on a mandatory business ID, with optional filters, pagination, sorting, and locale parameters, returning JSON responses for various status codes. |
|
|
| createCollection | This tool initializes a collection with mandatory properties for microservices, requiring a valid `businessId` and `name` in the request body, and provides detailed responses for various HTTP status codes. |
|
|
| getListById | This tool retrieves list details and items by list ID and collection ID, throwing errors for invalid or missing IDs. |
|
|
| deleteListById | This tool deletes a list and its associated data by list ID and collection ID, returning various responses based on success or error conditions. |
|
|
| updateListById | This tool patch updates list details by list ID and collection ID, returning various responses based on success or errors. |
|
|
| deletePropertiesByListId | This tool deletes a list property by name, list ID, and collection ID, throwing errors for invalid or missing parameters. |
|
|
| updatePropertiesByNameAndListId | This tool updates an existing property value in a list using a valid `listId` and `propertyName`, throwing errors for invalid inputs or missing IDs. |
|
|
| getListItemByIdAndListId | This tool retrieves a list item by its ID, list ID, and collection ID, returning errors for missing or invalid parameters. |
|
|
| deleteListItemByIdAndListId | This tool deletes an item using its listItemId, listId, and collectionId, throwing errors for missing or invalid IDs, with responses ranging from success to server errors. |
|
|
| updateListItemByIdAndListId | This tool patch updates a list item by its ID, list ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| deletePropertyByNameAndListIdAndItemId | This tool deletes an item property using property name, item ID, list ID, and collection ID, throwing errors for invalid or missing inputs. |
|
|
| updatePropertyByNameAndListIdAndItemId | This tool patch updates item properties using identifiers and throws errors for missing or invalid inputs, with various response codes indicating success or specific issues. |
|
|
| refreshApi_1 | This tool updates secret keys without a restart, cleans instance data, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS updates, and requires keyName and resetRequired parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves and filters standard roles and privileges from `roles_privileges.json` but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of the service, providing responses based on success, errors, or resource availability. |
|
None |
| getAllPrivileges | This tool fetches service privileges listed in `roles_privileges.json` within the microservice classpath, returning them as JSON on success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool provides a timestamp in milliseconds to confirm service availability. |
|
None |
| getCacheValue | This tool retrieves cached data for a service using a specified string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis-supported regex pattern, defaulting to ‘*’. |
|
None |
| getPropertyByCollectionId AndPropertyName |
This tool retrieves a collection property by its name, requiring mandatory parameters and returning JSON responses for various status codes. |
|
|
| getCollectionAttributes | This tool retrieves collection attributes for a microservice, detailing properties like type, default values, and constraints based on the collection level. |
|
|
| deleteMultiListItemById | Deletes multiple list items from a specified list using the unique list ID, with locale-based responses and various status codes. |
|
|
| cacheClear_2 | This tool clears all cache or specific cache by name and ID(s) based on provided parameters. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): Success |
| 201 | (Success): Created |
| 202 | (Success): Accepted |
| 204 | (Success): No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | The resource you are trying to reach is not found |
| 409 | Conflict Request |
| 422 | Invalid Request |
| 500 | Internal Server Error occurred |
Useful Resources
- API Specifications: API Endpoints – Lists
- Services Details: Lists Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added