MCP Server and Resource Metrics
- Server URL:
https://<domain>/foundation/mcp - Total Tools: 100
- Total Error Codes: 12
Server Overview
The MCP server provides a robust suite of 100 tools designed to manage and optimize user presets, templates, stores, associations, site data, sellers, businesses, caching, and system configurations, enabling seamless integration, efficient data handling, and enhanced operational workflows for businesses.
Tools
The following table lists the available MCP tools for Foundation service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| loadUserPresets | This tool retrieves all user presets based on User ID and optional query parameters like type, filter, pagination, and sorting. |
|
|
| updateUserPreset | This tool updates the User Preset using the User Preset ID and returns various responses based on success or error conditions. |
|
|
| createUserPresets | This tool creates a User Preset using a required User ID and returns various status codes with corresponding JSON responses. |
|
|
| deleteUserPreset | This tool deletes a User Preset based on the User Preset ID and provides various response codes for success or errors. |
|
|
| updateTemplateProperty | This tool updates all template properties using `templateId` and `businessId` with various response codes indicating success or errors. |
|
|
| createTeamplateProperties | This tool creates template properties using `templateId` and `businessId` parameters, with various response codes indicating success or errors. |
|
|
| findById | This tool retrieves a configuration template using templateId and businessId, with responses indicating success or various errors. |
|
|
| updateTemplate | This tool updates a template using required parameters and provides various response codes with detailed JSON outputs. |
|
|
| deleteById | This tool deletes a configuration template using `templateId` and `businessId`, returning success or error responses with detailed properties. |
|
|
| patchTemplate | This tool updates all or specific template attributes using templateId, businessId, and storeId, with detailed success and error responses. |
|
|
| getStore | This tool provides details of a specific store using a unique storeId parameter, with responses indicating success or various error states. |
|
|
| replaceStore | This tool updates store details using a unique storeId and returns various store attributes or error codes based on the response. |
|
|
| updateStore | This tool updates all or specific attributes of a store based on the provided store object and unique store identifier. |
|
|
| getStoreProperties | This tool retrieves a store’s property list based on specified parameters and provides detailed responses for success or errors. |
|
|
| replaceStoreProperties | This tool updates a store’s property list using a unique store ID, returning various responses based on success or errors. |
|
|
| createStoreProperties | This tool generates a list of properties for a specified store using a unique store ID, with detailed success and error response formats. |
|
|
| getStorePropertyByName | This tool retrieves a specific property of a store using its unique store ID and property name. |
|
|
| updateStorePropertyByName | This tool updates a specific property of a store using its unique store ID and property name, returning success or error responses based on the operation. |
|
|
| deleteStorePropertyByName | This tool removes a specified property from a store using its unique identifier and property name, returning various status codes based on the outcome. |
|
|
| getAssociations | This tool retrieves all associations of a specified store using path and query parameters, with detailed response formats for success and errors. |
|
|
| replaceAssociations | This tool updates a store’s association list using a unique store identifier and returns detailed responses based on success or error conditions. |
|
|
| createAssociations | This tool generates a list of associations for a specified store using its unique identifier. |
|
|
| getAssociationByName | This tool provides an association between a specified store and its service or collection details. |
|
|
| updateAssociationByName | This tool updates a specified store’s association using required path and query parameters, with detailed success and error responses. |
|
|
| deleteAssociationByName | This tool deletes a specific association of a store using required parameters and returns various response codes based on the outcome. |
|
|
| getAssociationProperties | This tool provides a list of properties for an associated service based on specified parameters and returns responses in JSON format. |
|
|
| replaceAssociationProperties | This tool updates the properties of a service using store, name, and collection identifiers, with detailed success and error responses. |
|
|
| createAssociationProperties | This tool generates a list of properties for a specified service using store, name, and collection identifiers, with detailed response codes and formats. |
|
|
| getAssociationPropertyByName | This tool retrieves specific properties of an associated service using path and query parameters, returning JSON responses for various status codes. |
|
|
| updateAssociation PropertyByName |
This tool updates a specific property of an associated service using required parameters and returns success or error responses in JSON format. |
|
|
| deleteAssociation PropertyByName |
This tool deletes a specific property of an associated service using required path and query parameters, returning various response codes based on the operation’s outcome. |
|
|
| getSiteDataServiceAssociation | This tool provides siteServiceAssociation details using a unique identifier and returns various response codes with JSON data. |
|
|
| replaceSitedata ServiceAssociation |
This tool updates sitedataServiceAssociation details using specific path and query parameters, returning various response codes based on success or errors. |
|
|
| deleteSitedata ServiceAssociation |
This tool deletes a specific siteServiceAssociation using a unique identifier and provides various response codes based on the operation’s outcome. |
|
|
| patchSitedata ServiceAssocition |
This tool updates store attributes for a given sitedataServiceAssociation using specified parameters and returns detailed responses based on success or error conditions. |
|
|
| findById_1 | This tool provides Site Data Association details using a unique identifier with responses for success or various error states. |
|
|
| updateSiteDataAssociation | This tool updates Site Data Association details using unique identifiers and provides responses for success or various error conditions. |
|
|
| deleteById_1 | This tool deletes Site Data Association data for a given unique identifier and provides detailed response codes and messages. |
|
|
| updateSiteDataAssociation_1 | This tool updates all or selected attributes of a Site Data Association using unique identifiers for site, site data, and association, with various response codes indicating success or errors. |
|
|
| findById_2 | This tool retrieves site data using a unique identifier, with responses indicating success or various error states. |
|
|
| replaceSiteData | This tool updates SiteData details using path and query parameters, returning various responses based on the request’s outcome. |
|
|
| deleteById_2 | This tool deletes site data for a given unique identifier and provides response codes/messages for success or errors. |
|
|
| updateSiteData | This tool updates all or specific siteData attributes for a given site using unique identifiers and provides various response codes based on the operation’s outcome. |
|
|
| getSites | This tool provides site details based on a unique siteId, with various response codes for success or errors. |
|
|
| replaceSite | This tool updates site details using a unique site identifier and returns various responses based on the request’s success or error status. |
|
|
| deleteSite | This tool deletes a site using its unique site ID, returning various response codes based on the outcome. |
|
|
| updateSite | This tool updates all or selected attributes of a specified site using its unique identifier and provides various responses based on the request outcome. |
|
|
| getSellerById | This tool retrieves seller details using a unique sellerId and provides various response codes based on the request outcome. |
|
|
| replaceSeller | This tool updates a seller using unique identifiers for seller, store, and site, returning success or error responses in JSON format. |
|
|
| deleteSeller | This tool deletes a seller using their unique sellerId and returns appropriate response codes and messages based on the operation’s outcome. |
|
|
| updateSeller | This tool updates all or specific seller attributes using sellerId, storeId, and siteId, with responses ranging from success to various error codes. |
|
|
| getBusiness | This tool retrieves business details using a unique businessId and provides structured responses for success or errors. |
|
|
| replaceBusiness | This tool updates a business by its ID and provides detailed responses for success or various error conditions. |
|
|
| updateBusiness | This tool updates all or specific attributes of a business using its ID and detailed request body. |
|
|
| getStoreServiceProperties | This tool retrieves service properties of a specified store using unique business and store IDs. |
|
|
| replaceStoreServiceProperties | This tool generates a list of service properties for a specified store using unique business and store IDs. |
|
|
| getBusinessProperties | This tool retrieves filtered business properties for a specific business ID, applying sort, search, pagination, and filter criteria. |
|
|
| replaceBusinessProperties | This tool updates a business’s property list using a unique business ID and provides responses for success or various errors. |
|
|
| createBusinessProperties | This tool generates a list of unique business properties for a specified business ID, with detailed response codes and formats. |
|
|
| getBusinessPropertyByName | This tool retrieves a specific business property based on the provided business ID and property name, returning detailed responses for success or various error states. |
|
|
| updateBusiness PropertyByName |
This tool updates a specific business property using a unique business ID and property name, returning success or error responses based on the operation. |
|
|
| deleteBusiness PropertyByName |
This tool deletes a specific business property using a unique business ID and property name, returning success or error responses with details. |
|
|
| findAll | This tool retrieves all configuration templates based on query parameters and provides structured JSON responses for success or various error codes. |
|
|
| createTemplate | This tool creates a template using storeId and businessId, returning various response codes and JSON properties based on the outcome. |
|
|
| getStores | This tool retrieves all stores associated with a specified business using various query parameters and provides detailed response properties. |
|
|
| createStore | This tool creates a store using a valid business ID and returns detailed store properties upon success. |
|
|
| getAllSitedata ServiceAssoctaions |
This tool provides all SitedataServiceAssociations for a specified sitedataId with filtering, sorting, and pagination options. |
|
|
| createSitedat ServiceAssociation |
This tool links sitedata with a service, using a valid sitedata ID to create associations and returning various responses based on success or errors. |
|
|
| getSites_1 | This tool retrieves all sites of a specified seller with filtering, sorting, and detailed response options. |
|
|
| createSite | This tool creates a site and returns detailed responses based on success or error conditions. |
|
|
| findAll_1 | This tool retrieves site data for a specified site using query parameters like siteId, filters, pagination, and sorting, with detailed response codes and examples. |
|
|
| create | This tool creates siteData using a unique siteId and provides responses for success, errors, or authorization issues. |
|
|
| findAll_2 | This tool retrieves Site Data Association details for a specified site using query parameters like siteId, filter, pagination, sorting, and complex criteria. |
|
|
| create_1 | This tool creates a SiteDataAssociation using siteId and sitedataId, with responses indicating success or various error states. |
|
|
| createSeller | This tool creates a seller using storeId and siteId, returning success or error responses based on the request. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS calls, and uses `keyName` and `resetRequired` parameters. |
|
None |
| cacheClear | This tool clears cached data based on specified cache names, supports string-type keys, and clears 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 a code, message, and timestamp. |
|
|
| getBusinesses | This tool provides filtered business listings based on sort, search, page, and size parameters, with detailed response and error handling. |
|
|
| createBusiness | This tool generates a business with a unique name and provides detailed response properties for success or error cases. |
|
|
| getStoreServiceProperty | This tool provides details about a specific service property of a store using unique identifiers for the business, store, and property. |
|
|
| updateStoreServiceProperty | This tool updates specific service property attributes of a store using unique identifiers and a request body. |
|
|
| getTemplateByNameProperties | This tool retrieves template properties using specified parameters and returns responses based on success or error codes. |
|
|
| deleteTeamplateProperty | This tool deletes a template property using required parameters and returns status codes with detailed responses. |
|
|
| getAllSellersByStoreId | This tool retrieves all sellers of a specified store based on query parameters like filters, pagination, and sorting. |
|
|
| getAllSellersBySiteId | This tool retrieves all sellers from a specified site with filtering, sorting, and pagination options, returning structured JSON responses for various status codes. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, clears instance data for AWS calls, 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, and uses `keyName` and `resetRequired` parameters. |
|
None |
| getStoreIds | This tool retrieves store IDs based on a specified collection ID and service name, using query parameters like businessId, collectionId, and serviceName. |
|
|
| 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 a service and provides structured responses for success, errors, or resource not found scenarios. |
|
None |
| getAllPrivileges | This tool fetches all service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning them as JSON 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 returns 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 |
| getFoundationChangeLog | This tool retrieves change logs within a specified time range, supporting sorting, filtering, pagination, and various response codes. |
|
|
| clearCacheByName | This tool clears the cache for business and store, returning various status codes based on the response. |
|
|
| clearCaches | This tool clears the cache for a specified cache name and returns various status codes based on the operation’s outcome. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): Delete Success |
| 201 | (Success): Success |
| 204 | (Success): Success |
| 304 | Not modified |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 417 | Expectation Failed |
| 422 | Invalid request |
| 500 | Internal Server Error |
Useful Resources
- API Specifications: API Endpoints – Foundation
- Services Details: Foundation Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added