MCP Server and Resource Metrics
- Server URL:
https://<domain>/notification/mcp - Total Tools: 35
- Total Error Codes: 7
Server Overview
The MCP server provides robust capabilities for managing collections, events, actions, notifications, caching, and system configurations, enabling seamless data retrieval, updates, and error handling while ensuring operational efficiency and scalability for businesses.
Tools
The following table lists the available MCP tools for Notification service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getCollection | This tool retrieves a collection and its properties using specified business and collection IDs, with responses indicating success, errors, or resource status. |
|
|
| replaceCollection | This tool updates a collection by modifying all attributes and requires all associated properties to be included in the request. |
|
|
| replaceCollectionProperties | This tool updates collection properties in bulk by replacing existing ones and creating new ones for a specified collection ID and business ID, returning various response codes based on success or errors. |
|
|
| updateCollectionPropertyByName | This tool updates collection property values based on provided names, validating only the fields in the request object, with responses indicating success or specific errors. |
|
|
| sendNotification | This tool triggers email or SMS actions based on event names, providing detailed response codes and error information. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS calls, using keyName and resetRequired parameters. |
|
None |
| getEvents | This tool retrieves system events for a valid collection ID based on search, sort, pagination, and filter parameters, with detailed response codes and examples. |
|
|
| createEvent | This tool creates an event linked to a collection ID based on valid request parameters, with detailed response codes and properties. |
|
|
| cacheClear_1 | This tool clears cached data for specified cache names, supports string-type keys, and can clear entire caches if no key or pattern is provided. |
|
|
| cacheClear | This tool clears cached data using dynamic cache keys and returns a JSON response with a code, message, and timestamp. |
|
|
| getCollections | This tool retrieves notification collections for a specified business ID based on search, sort, page, and size parameters. |
|
|
| createCollection | This tool creates a collection with specified or default properties, restricting new property names not in existing attributes, and provides detailed responses for various statuses. |
|
|
| getActions | This tool retrieves system actions for a valid collection ID based on search, sort, pagination, and filter parameters, with detailed response codes and examples. |
|
|
| createAction | This tool creates an action linked to a collection ID based on valid request parameters, with detailed response codes and properties for success, errors, or default cases. |
|
|
| getEvent | This tool retrieves event details using a valid event ID and collection ID, with various response codes indicating success or errors. |
|
|
| deleteEvent | This tool deletes an event using a valid event ID and collection ID, returning success or error responses with detailed codes and messages. |
|
|
| updateEvent | This tool updates specific or all fields of an event using event and collection IDs, returning detailed response codes and messages. |
|
|
| getAction | This tool retrieves an action using a valid action ID and collection ID, returning various response codes and details based on the request outcome. |
|
|
| deleteAction | This tool deletes an action using a valid action ID and collection ID, returning success or error responses in JSON format. |
|
|
| updateAction | This tool updates specified fields of an action object using valid action and collection IDs, with responses indicating success, errors, or resource status. |
|
|
| refreshApi_1 | This tool updates secret keys without restarting, clears instance data for AWS updates, 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 |
| refreshApi_2 | This tool updates secret keys without restart, cleans instance data, and uses keyName and resetRequired parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves standard roles and privileges from a JSON file, filters by `roleName`, 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 success, errors, and validation. |
|
None |
| getAllPrivileges | This tool fetches service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning a JSON array 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 verifies the operational status of the Notification service and provides details about notification events, sender, and recipients. |
|
None |
| getCacheValue | This tool retrieves cached data for a specified service using a string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionPropertyByName | This tool retrieves a collection property using its name and collection ID, with responses indicating success, errors, or exceptions. |
|
|
| getCollectionattributes | This tool retrieves collection attributes and their properties, supporting various data types and response codes for different scenarios. |
|
|
| CacheController_cache Clear_ApiOperation_notes |
The tool clears all caches and returns a JSON response with status, timestamp, and validation error details. |
|
None |
| CacheController_cacheClear ByName_ApiOperation_notes |
Clear cache by specifying the cache name, with a JSON response detailing success or validation errors. |
|
None |
| CacheController_cacheClear ByNameAndKey_ApiOperation_note |
Clear cache by specifying cache name and key, returning a JSON response with status, message, timestamp, and validation errors. |
|
None |
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): Success |
| 201 | Created |
| 202 | (Success): Accepted |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | The resource you are trying to reach is not found |
| 500 | Server exception caused by non-client errors |
Useful Resources
- API Specifications: API Endpoints – Notification
- Services Details: Notification Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added