MCP Server and Resource Metrics
- Server URL:
https://<domain>/address/mcp - Total Tools: 24
- Total Error Codes: 8
Server Overview
The MCP server offers robust data management, caching, validation, and microservice support functionalities, enabling streamlined operations, enhanced scalability, and precise control over collections, roles, privileges, and address validation processes.
Tools
The following table lists the available MCP tools for Address service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getCollectionById | This tool retrieves collection details and properties based on business and collection IDs, throwing errors for missing parameters. |
|
|
| replaceCollectionById | This tool updates collection properties based on business and collection IDs, requiring a mandatory field name in the request. |
|
|
| replacePropertiesByCollectionId | This tool updates collection properties based on mandatory field inputs and specified identifiers, returning various responses depending on success or error conditions. |
|
|
| updatePropertiesByCollectionId | This tool patch updates collection properties, requiring a mandatory field name and valid identifiers, with detailed error responses for various scenarios. |
|
|
| validateAddress | This tool validates addresses using custom plugins like Cybersource, caches results, and provides responses in various formats based on request parameters. |
|
|
| deleteAllAddressValidation | This tool clears all caches under a collection and provides locale-specific responses with status codes and address details. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| cacheClear | This tool clears cached data for specified cache names, 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 returns a JSON response with status, message, and timestamp. |
|
|
| getCollections | This tool retrieves collections based on a mandatory business ID, with optional sorting, filtering, locale, pagination, and error handling. |
|
|
| createCollection | This tool initializes a collection with mandatory properties for microservices, requiring a valid `businessId` and `name` in the request, and provides detailed responses for success or various error scenarios. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, clears instance data, and uses `keyName` and `resetRequired` parameters for AWS calls. |
|
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 calls, and uses keyName and resetRequired parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves roles and privileges from `roles_privileges.json`, 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 and provides responses based on HTTP status codes. |
|
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 returns a timestamp in milliseconds to confirm service availability. |
|
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-supported regex pattern, defaulting to ‘*’. |
|
None |
| getPropertyByCollectionId AndPropertyName |
This tool retrieves the collection property based on the given property name, requiring mandatory field inputs and returning appropriate error codes for invalid requests. |
|
|
| getCollectionAttributes | This tool retrieves collection attributes for a microservice, using query parameters like businessId and locale, with responses indicating success or various errors. |
|
|
| deleteAddressValidationById | This tool clears a specific cache for an address identifier, with locale-based responses and detailed error codes. |
|
|
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 |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | The resource you are trying to reach is not found |
| 409 | Conflict Request |
| 500 | Internal Server Error occurred |
Useful Resources
- API Specifications: API Endpoints – Address
- Services Details: Address Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added