MCP Server and Resource Metrics
- Server URL:
https://<domain>/subscription/mcp - Total Tools: 54
- Total Error Codes: 12
Server Overview
The MCP server offers a robust suite of 54 tools designed to manage collections, subscriptions, instances, transactions, caching, and user preferences, enabling efficient data handling, customization, and error management for seamless business operations.
Tools
The following table lists the available MCP tools for Subscription service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getCollectionById | This tool retrieves collection details based on business and collection IDs, throwing errors for missing parameters. |
|
|
| replaceCollectionById | This tool updates collection properties using business and collection IDs, requiring a mandatory field name, and returns various responses based on operation success or errors. |
|
|
| replaceProperties ByCollectionId |
This tool updates collection properties with a mandatory field name and performs operations based on provided identifiers, returning success or error responses. |
|
|
| updateProperties ByCollectionId |
This tool patch updates collection properties, requiring a mandatory field name, and provides detailed responses for various status codes. |
|
|
| getSubscriptions | This tool retrieves subscription data with customizable query parameters and detailed response/error handling. |
|
|
| createSubscription | This tool enables bulk creation of subscriptions with detailed response codes and error handling. |
|
|
| addItemToSubscription | This tool allows adding items to a subscription using a unique subscription ID and supports various response statuses for success or errors. |
|
|
| getInstances | This tool retrieves all subscription instances with sorting, filtering, and pagination options, returning detailed responses or error codes. |
|
|
| createInstance | This tool creates a subscription instance using a unique subscription ID and provides various response codes for success or errors. |
|
|
| updateInstance | This tool updates a subscription instance using subscription ID, action, and instance ID, with various response codes for success or errors. |
|
|
| updateTransactions | This tool facilitates creating transactions to update an instance with various status and response codes. |
|
|
| createProcessSummary | This tool generates a Subscription Process Summary with detailed responses based on path and query parameters. |
|
|
| refreshSubscription | This tool refreshes and retrieves user subscription data based on user ID and optional query parameters. |
|
|
| updateSubscriptions | This tool updates failed subscriptions with pagination, locale, and type-specific options, returning detailed responses for various status codes. |
|
|
| createSubscription_1 | This tool enables bulk creation of subscriptions with detailed response codes and error handling. |
|
|
| refreshApi | This tool updates secret keys without a restart, clears instance data for AWS calls, and uses `keyName` and `resetRequired` parameters. |
|
None |
| getAllSubscriptionPreference | This tool retrieves subscription preferences with sorting, filtering, pagination, and locale options, returning detailed responses or error codes. |
|
|
| createSubscriptionPreference | This tool creates subscription preferences and provides detailed responses for various statuses. |
|
|
| updateBulkInstance | This tool facilitates bulk updating of instances with detailed responses for various status codes. |
|
|
| updateBulkInstance_1 | This tool updates bulk instances by subscription IDs with various actions and response codes. |
|
|
| cacheClear | This tool clears cached data by cache name(s), supports string-type keys, and can clear 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 HTTP statuses. |
|
|
| getCollections | This tool retrieves collections based on a mandatory business ID, with optional sorting, filtering, and pagination parameters, returning various success or error responses. |
|
|
| createCollection | This tool initializes a collection with properties for microservices, requiring mandatory fields, and provides detailed responses for various statuses. |
|
|
| patchUpdateItemInterval | This tool updates the item interval in a subscription using specified parameters and returns detailed responses for various status codes. |
|
|
| getSubscription | This tool retrieves subscription details by ID with optional locale and month parameters, returning success or error responses. |
|
|
| deleteSubscription | This tool deletes a user’s subscription(s) with options for soft or hard deletion and various response codes. |
|
|
| updateSubscription | This tool updates subscription fields by ID and provides detailed responses for success or errors. |
|
|
| patchUpdateItemById | This tool updates required fields of an item using its Item ID with various response codes for success or errors. |
|
|
| getSubscriptionInterval BySubscriptionId |
This tool retrieves subscription interval details using a subscription ID with various response codes for success or errors. |
|
|
| patchUpdate SubscriptionInterval |
This tool updates the subscription interval for a given subscription using specified parameters and provides detailed response codes. |
|
|
| deleteSubscriptionUser | This tool deletes a user’s subscription(s) with options for physical deletion, locale-based responses, and filtering criteria. |
|
|
| patchUpdateSubscription | This tool updates user subscription fields by User ID, with customizable filters and locale options, returning detailed subscription data or error responses. |
|
|
| getSubscriptionPreference | This tool retrieves a user’s subscription preferences using their user ID and supports localized responses. |
|
|
| deleteSubscriptionPreference | This tool removes a user’s subscription preferences using their user ID and supports locale-specific responses with detailed status codes. |
|
|
| patchSubscriptionPreference | This tool updates a user’s subscription preferences based on their user ID and specified parameters, returning detailed responses for success or errors. |
|
|
| getInstance | This tool retrieves a subscription instance by its unique ID, supporting locale-based responses and various status codes. |
|
|
| getFrequencyType | Retrieve subscription frequency types using a collection ID with detailed responses for success and error scenarios. |
|
|
| getProcessSummary | This tool retrieves the Process Summary of a subscription with sorting, filtering, pagination, and locale options, returning detailed responses for success or errors. |
|
|
| getFirstDeliveryDate | This tool provides subscription order details, including user-preferred delivery dates, processing intervals, and error responses. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, cleans instance data, and uses `keyName` and `resetRequired` parameters for AWS calls. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, cleans instance data, and requires `keyName` and `resetRequired` parameters with detailed response codes. |
|
None |
| refreshApi_2 | This tool updates secret keys without restart, clears instance data for AWS calls, and uses keyName and resetRequired parameters. |
|
None |
| 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. |
|
None |
| getAllPrivileges | This tool retrieves service privileges from `roles_privileges.json` and provides 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, returning subscription and pageable info or error details. |
|
|
| ping | This tool provides the current date and time to check service availability, 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 detailed success and error responses. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service based on a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getPropertyByCollectionId AndPropertyName |
This tool retrieves a collection property by name, requiring mandatory field inputs and throws errors for missing parameters. |
|
|
| getCollectionAttributes | This tool retrieves collection attributes for a microservice, with responses varying by status codes and query parameters like businessId and locale. |
|
|
| cacheClear_2 | This tool clears all cache or specific cache by name and ID, with query parameters for locale and cacheKey, and provides detailed success or error responses. |
|
|
| deleteItemByItemId | This tool deletes subscription items using item IDs and provides detailed responses for various status codes. |
|
|
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): success |
| 202 | (Success): Accepted |
| 204 | (Success): No Content |
| 208 | Already Reported |
| 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 – Subscription
- Services Details: Subscription Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added