MCP Server and Resource Metrics
- Server URL:
https://<domain>/ecommreporting-mcp/mcp - Total Tools: 28
- Total Error Codes: 11
Server Overview
The MCP server offers robust capabilities for managing collections, reports, caching, and user privileges, enabling streamlined data retrieval, updates, and secure operations through a suite of 28 specialized tools tailored for efficient business workflows.
Tools
The following table lists the available MCP tools for Reporting service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getCollection | This tool retrieves a collection using its identifier, with locale and businessId parameters, and provides responses based on operation success or errors. |
|
|
| replaceCollection | This tool updates a collection by its ID, requiring name, description, and status while disallowing updates to collectionId and businessId, with detailed response codes for various scenarios. |
|
|
| replaceCollectionProperties | This tool updates collection properties for a specific collection ID, creating new ones and replacing existing ones based on the request. |
|
|
| updateCollectionProperties | This tool updates specified collection properties based on provided parameters, validating and modifying only the fields included in the request. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| getReports | This tool retrieves reports from a specified collection, with optional filters, pagination, and privileges for users with ‘view report’ access. |
|
|
| createReport | This tool allows users with ‘create report’ privilege to generate a new report under a collection, returning success or error responses based on input validity. |
|
|
| cacheClear | This tool clears cached data for specified cache names, supports string-type keys, and can clear the entire cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and returns a JSON response with a code, message, and timestamp. |
|
|
| getCollections | This tool retrieves Report service collections based on search terms and supports pagination, filtering, and locale-specific responses. |
|
|
| createCollection | This tool creates a collection with specified or default properties, disallowing new attributes, and provides locale-specific responses for various status codes. |
|
|
| getReport | This tool loads a report from a collection using report and collection IDs, accessible to users with ‘view report’ privilege. |
|
|
| deleteReport | This tool deletes a report from a collection using a report ID, requiring ‘delete report’ privilege, and returns various response codes based on the outcome. |
|
|
| updateReport | This tool allows users with ‘update report’ privileges to modify report attributes, including replacing the entire ReportParam model for updates, using a valid reportId. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, clears instance data, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| refreshApi_2 | This tool updates secret keys without restart, clears instance data for AWS updates, requiring `keyName` and `resetRequired` parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves standard roles and privileges from `roles_privileges.json`, filters by `roleName`, but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReportData | This tool retrieves report data by executing its associated query, requiring valid parameters and user privileges, with responses indicating success or specific errors. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service with various response codes indicating success or errors. |
|
None |
| getAllPrivileges | This tool retrieves all service privileges listed in `roles_privileges.json` and returns them as a JSON array upon success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool checks the availability of the Report service and provides status responses. |
|
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 regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionPropertyByName | This tool retrieves a collection property by name using specified path and query parameters, returning responses based on success or error codes. |
|
|
| getCollectionAttributes | This tool retrieves collection attributes and their properties, with responses based on query parameters like businessId and locale. |
|
|
| deleteReportProperty | This tool deletes a report property using the report ID and property name, requiring ‘delete report property’ privilege. |
|
|
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): success |
| 202 | (Success): success |
| 204 | (Success): success |
| 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 – Reporting
- Services Details: Reporting Service
Revision History
2025-09-29 | SD – Page created and content added