MCP Server and Resource Metrics

  • Server URL: https://<domain>/catalog/mcp
  • Total Tools: 95
  • Total Error Codes: 11

Server Overview

The MCP server offers a robust suite of 95 tools designed for managing catalog, project, product, and attribute data, enabling efficient operations like retrieval, creation, updates, and deletions, while supporting advanced functionalities such as caching, localization, and reporting to streamline business workflows and enhance data-driven decision-making.

Tools

The following table lists the available MCP tools for Catalog service along with their descriptions and required/optional parameters:

Tool Name Tool Description Required Parameters Optional Parameters
getCollection This tool retrieves a collection using a specified collection ID and supports various response statuses.
  • x-auth-token
  • id
  • businessId
  • x-api-key
  • x-version
  • locale
replaceCollection This tool updates all fields in a collection based on the provided collection request, with required parameters and detailed response codes.
  • x-auth-token
  • businessId
  • id
  • x-api-key
  • x-version
  • locale
replaceCollectionProperties This tool updates all properties within a specified collection of a microservice, with responses indicating success or various error states.
  • x-auth-token
  • id
  • businessId
  • x-api-key
  • x-version
  • locale
updateCollectionProperties This tool updates the properties of an existing collection within a microservice based on provided identifiers and parameters.
  • x-auth-token
  • businessId
  • id
  • x-api-key
  • x-version
  • locale
getCatalog This tool retrieves a catalog using a unique catalog ID and supports locale-specific responses.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • x-version
  • locale
replaceCatalog This tool updates catalog data using specified parameters and provides detailed responses for success or errors.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • type
  • status
  • subType
  • adminFilter
  • sfFilter
  • locked
  • x-version
  • locale
  • identifier
  • collectionId
  • startTime
  • endTime
  • properties
deleteCatalog This tool deletes a catalog using a unique catalog ID and provides detailed responses for various outcomes.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • x-version
  • locale
updateCatalog This tool updates catalog data using specified parameters and provides detailed responses for various statuses.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • type
  • status
  • subType
  • adminFilter
  • sfFilter
  • locked
  • x-version
  • locale
  • identifier
  • collectionId
  • startTime
  • endTime
  • properties
replaceCatalogProperties This tool updates catalog properties using a catalogId, with responses ranging from success (200) to various error codes (400–500).
  • x-auth-token
  • x-collection-id
  • catalogId
  • x-api-key
  • x-version
  • locale
updateCatalogProperties This tool updates catalog properties using a unique catalogId and supports various response codes for success or errors.
  • x-auth-token
  • x-collection-id
  • catalogId
  • x-api-key
  • x-version
  • locale
getProject This tool retrieves project details using a project ID and catalog ID, with customizable locale and detailed response formats.
  • x-collection-id
  • x-auth-token
  • projectId
  • catalogId
  • x-api-key
  • x-version
  • locale
replaceProject This tool updates all project fields based on the provided ProjectRequest object and returns detailed responses for various statuses.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
deleteProject This tool deletes a specified project from a catalog using unique IDs and provides detailed response codes and messages.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
updateProject This tool updates required project fields using the ProjectRequest object and provides detailed response codes for various outcomes.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
replaceSkuProperties This tool updates all SKU property fields based on the SkuPropertyRequest object, with various response codes indicating success or errors.
  • x-auth-token
  • x-collection-id
  • skuId
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
updateSkuProperties This tool updates SKU properties using a SkuPropertyRequest object and returns responses based on success or error codes.
  • x-auth-token
  • x-collection-id
  • skuId
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
getSku This tool retrieves product details using a product ID, returning SKU data in schema.org format with various status and metadata properties.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • skuId
  • x-api-key
  • x-version
  • locale
replaceSku This tool updates all SKU fields based on the provided SkuRequest object, using catalog, project, and SKU identifiers.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • skuId
  • x-api-key
  • x-version
  • locale
deleteSku This tool deletes a specified SKU using provided catalog, project, and query parameters, returning various response codes based on the operation’s outcome.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • skuId
  • x-api-key
  • x-version
  • locale
updateSku This tool updates SKU fields based on the SkuRequest object, using catalogId, projectId, and skuId parameters, with detailed response codes and properties.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • skuId
  • x-api-key
  • x-version
  • locale
replaceProductProperties This tool updates all product property fields using a ProductPropertyRequest object, with various response codes indicating success or errors.
  • x-collection-id
  • x-auth-token
  • productId
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
updateProductProperties This tool updates product properties using a ProductPropertyRequest object and provides responses based on various status codes.
  • x-collection-id
  • x-auth-token
  • productId
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
getProduct This tool retrieves product details using a product ID, returning schema.org format with SKU information and various response codes.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • productId
  • x-api-key
  • x-version
  • locale
replaceProduct This tool updates product information using specified parameters and returns detailed responses based on the operation’s outcome.
  • x-collection-id
  • x-auth-token
  • projectId
  • catalogId
  • productId
  • x-api-key
  • x-version
  • locale
deleteProduct This tool deletes a product from the catalog using specified project, catalog, and product IDs, with various response codes indicating success or errors.
  • x-collection-id
  • x-auth-token
  • projectId
  • catalogId
  • productId
  • x-api-key
  • x-version
  • locale
updateProduct This tool updates product information using specific parameters and provides detailed responses for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • productId
  • projectId
  • x-api-key
  • x-version
  • locale
getAttribute This tool retrieves product or SKU attribute details, including status (ACTIVE/INACTIVE), using unique IDs and locale-specific responses.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
replaceAttribute This tool updates all attribute fields based on the provided AttributeRequest object and returns detailed responses for various statuses.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
deleteAttribute This tool deletes an attribute using its unique ID, with locale-based responses and various status codes indicating outcomes.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
updateAttribute This tool updates attribute fields based on the provided AttributeRequest object and returns detailed responses for various status codes.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
replaceAttributeProperties This tool updates the attribute property of a catalog collection with responses for various status codes.
  • x-auth-token
  • x-collection-id
  • attributeId
  • x-api-key
  • x-version
  • locale
updateAttributeProperties This tool updates the attribute property of a catalog collection using specified parameters and provides detailed response codes for success or errors.
  • x-auth-token
  • x-collection-id
  • attributeId
  • x-api-key
  • x-version
  • locale
getAttributeGroup This tool retrieves an attribute group using a specified attribute group ID and supports locale-based responses.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
replaceAttributeGroup This tool updates an attribute group in a catalog collection using specified parameters and provides detailed response codes for success or errors.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
deleteAttributeGroup This tool deletes an attribute group from a catalog collection using a unique ID and supports various response codes for operation status.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
updateAttributeGroup This tool updates an attribute group in a catalog collection using specified parameters and returns various response codes based on the operation’s outcome.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
refreshApi This tool updates secret keys without a restart, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters with detailed response codes.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
getModels This tool retrieves all models from a catalog collection with sorting, filtering, pagination, and locale options.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • sort
  • filters
  • page
  • size
  • locale
createModel This tool creates a model within a catalog collection, providing detailed response codes and properties for various statuses.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • locale
cacheClear This tool clears cached data for specified cache names, supports string-type keys, and clears entire cache if no key or pattern is provided.
  • x-auth-token
  • cacheName
  • x-api-key
  • cacheKey
  • pattern
cacheClear_1 This tool clears cached data using dynamic cache keys and provides detailed response codes and messages for various statuses.
  • x-api-key
  • cacheNames
  • cacheKey
  • simpleKey
  • pattern
getCollections This tool retrieves collections with pagination, sorting, filtering, and locale support, providing detailed responses for various status codes.
  • x-auth-token
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • businessId
  • locale
createCollection This tool creates a collection based on a provided request, with responses indicating success, errors, or conflicts.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
getCatalogs This tool retrieves active and inactive catalogs with pagination, filtering, sorting, and locale options, returning detailed responses for various status codes.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • skipFilters
  • locale
createCatalog This tool creates a catalog within a collection, providing detailed response properties and error codes.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • type
  • status
  • subType
  • adminFilter
  • sfFilter
  • locked
  • x-version
  • locale
  • identifier
  • collectionId
  • startTime
  • endTime
  • properties
getProjects This tool retrieves projects based on input parameters like catalogId, filters, sorting, pagination, and locale, with detailed response codes for various outcomes.
  • x-collection-id
  • x-auth-token
  • catalogId
  • x-api-key
  • x-version
  • sort
  • filters
  • page
  • size
  • locale
createProject This tool creates a project using a ProjectRequest object, with various parameters and response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • x-api-key
  • x-version
  • locale
getSkus This tool deletes a specified SKU using provided catalog and project IDs, with optional query parameters for filtering, sorting, and pagination.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • sort
  • filters
  • page
  • size
  • locale
createSku This tool generates a SKU using the provided SkuRequest object and supports various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
getProducts This tool retrieves all products (ACTIVE & INACTIVE) from a catalog collection based on specified parameters and returns paginated, sortable, and filtered results.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • locale
createProduct This tool creates a product using a ProductRequest object and provides detailed responses based on success or error scenarios.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
getProjectNotes This tool retrieves all project notes associated with a project, supporting pagination, filtering, sorting, and localized responses.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • locale
createProjectNote This tool creates project notes for a given project, supporting multiple notes and various response statuses based on operation outcomes.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
createModelValue This tool creates a model value within a catalog collection using specified parameters and provides responses based on success or errors.
  • x-auth-token
  • x-collection-id
  • catalogId__path
  • projectId__path
  • modelId__path
  • x-api-key
  • collectionId
  • modelValueId
  • x-version
  • locale
  • versionId
  • status
  • createdTime
  • createdBy
  • updatedTime
  • updatedBy
  • catalogId
  • modelId
  • projectId
  • productId
  • skuId
  • mappingId
  • mappingType
  • modelType
  • attributes
getImageAssets This tool retrieves all image assets from a catalog collection using specified parameters and provides paginated, filtered, and localized responses.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • productId
  • skuId
  • filters
  • page
  • size
  • sort
  • locale
createImageAssets This tool creates an image asset within a catalog collection, using specified parameters and providing detailed responses for various outcomes.
  • x-collection-id
  • x-auth-token
  • changeType
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • locale
  • productId
  • skuId
  • prompt
  • imageUrl
  • backgroundImageUrl
  • status
  • properties
updateImageAssets This tool updates specified fields in an image asset using the `ImageAssetsRequest` object and supports various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • imageAssetsId
  • x-api-key
  • x-version
  • locale
  • file
getAttributes This tool retrieves product or SKU attributes from a catalog collection with sorting, filtering, pagination, and locale options, returning JSON responses for various status codes.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • sort
  • filters
  • page
  • size
  • locale
createAttribute This tool creates product or SKU attributes for catalog collections with detailed response and error handling.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • locale
getAttributeGroups This tool retrieves active and inactive attribute groups of a catalog collection with sorting, filtering, pagination, and locale options.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • sort
  • filters
  • page
  • size
  • locale
createAttributeGroup This tool creates an attribute group for a catalog collection with detailed response codes and properties.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • locale
getModel This tool retrieves model information, including its ACTIVE or INACTIVE status, using a unique model ID and optional locale parameter, with detailed error responses for various scenarios.
  • x-auth-token
  • x-collection-id
  • modelId
  • x-api-key
  • x-version
  • locale
deleteModel This tool deletes a model using a unique model ID, with options for soft or hard deletion and localized responses.
  • x-auth-token
  • x-collection-id
  • modelId
  • x-api-key
  • x-version
  • locale
  • is_delete
updateModel This tool updates model attributes based on a `ModelRequest` object, with responses indicating success, errors, or status changes.
  • x-auth-token
  • x-collection-id
  • modelId
  • x-api-key
  • x-version
  • locale
getModelValue This tool retrieves model value information, including its ACTIVE or INACTIVE status, within a catalog collection using specified parameters.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • modelId
  • modelValueId
  • x-api-key
  • x-version
  • locale
deleteModelValue This tool deletes a model value using the provided catalog, project, model, and model value IDs, with responses indicating success or specific errors.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • modelId
  • modelValueId
  • x-api-key
  • x-version
  • locale
updateModelValue This tool updates model value attributes based on a provided `ModelValue` object, with detailed parameters and response codes for various scenarios.
  • x-auth-token
  • x-collection-id
  • catalogId__path
  • projectId__path
  • modelId__path
  • modelValueId__path
  • x-api-key
  • collectionId
  • modelValueId
  • x-version
  • locale
  • versionId
  • status
  • createdTime
  • createdBy
  • updatedTime
  • updatedBy
  • catalogId
  • modelId
  • projectId
  • productId
  • skuId
  • mappingId
  • mappingType
  • modelType
  • attributes
updateImageAssets_1 This tool modifies specified fields of an image asset using the `ImageAssetsRequest` object and supports various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • imageAssetsId
  • x-api-key
  • x-version
  • locale
  • productId
  • skuId
  • prompt
  • imageUrl
  • backgroundImageUrl
  • status
  • properties
getVersions This tool retrieves versions based on input parameters with sorting, filtering, pagination, and locale options, returning detailed responses for various statuses.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version
  • sort
  • filters
  • locale
  • page
  • size
getVersion This tool retrieves a version using a unique version ID, with customizable parameters and detailed response formats.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
refreshApi_1 This tool updates secret keys without restarting, cleans instance data for AWS calls, and uses `keyName` and `resetRequired` parameters with various response codes.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
rabbitMQUpdateCredentials This tool updates RabbitMQ credentials, clears instance data for AWS calls, and requires parameters like `keyName` and `resetRequired`.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
getSku_1 This tool retrieves product details by product ID in schema.org format, including SKU information, with various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • skuId
  • x-api-key
  • x-version
  • locale
getProduct_1 This tool retrieves product details by product ID in schema.org format, including SKU information and various response codes for different outcomes.
  • x-collection-id
  • x-auth-token
  • catalogId
  • productId
  • x-api-key
  • x-version
  • locale
getAllStandrdRoles This tool retrieves and filters standard roles with privileges from `roles_privileges.json`, but has been deprecated since Infosys Equinox Commerce Release 8.3.0.
  • x-auth-token
  • x-api-key
  • roleName
getReleaseDefinition This tool retrieves the release definition of a service and provides detailed response codes and properties for various statuses.
  • x-auth-token
  • x-api-key
None
getAllPrivileges This tool retrieves service privileges from `roles_privileges.json` and provides detailed response codes for various statuses.
  • x-auth-token
  • x-api-key
None
getAllPrivilegeGroups This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter, with detailed response codes for various outcomes.
  • x-auth-token
  • x-api-key
  • privilegeGroupName
ping This tool provides the current date and time to check service availability, with various response codes indicating success or errors.
  • x-api-key
None
exportCatalogSheet This tool exports the sample catalog list as an .xlsx file with customizable sheets based on query parameters and provides detailed error responses for various statuses.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • importExportType
  • locale
  • x-version
  • page
  • size
getCacheValue This tool retrieves cached data for a specified service using string-based cache name and key, with detailed response codes for success or errors.
  • cacheName
  • cacheKey
  • x-auth-token
  • x-api-key
None
getCacheKeys This tool retrieves cache keys for a service based on a specified Redis regex pattern, defaulting to ‘*’.
  • pattern
  • x-auth-token
  • x-api-key
None
getCollectionPropertiesByName This tool retrieves a collection property using specified parameters and returns responses based on the operation’s outcome.
  • x-auth-token
  • businessId
  • id
  • name
  • x-api-key
  • x-version
  • locale
getCollectionAttributes This tool retrieves all collection attributes based on a valid business identifier, with detailed response codes for various outcomes.
  • x-auth-token
  • x-api-key
  • x-version
  • businessId
  • locale
getTagging The tool operation defines path and query parameters for catalog and project IDs, with detailed response codes and properties for various HTTP statuses.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • tagName
  • tagGroupName
  • x-api-key
  • x-version
getProducts_1 The tool operation retrieves product data based on catalog and project IDs, with optional query parameters for pagination, sorting, filtering, locale, and item details, returning various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • itemType
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • locale
  • ItemId
  • tagAttribute
getProduct_2 This tool retrieves product details based on a product ID, returning SKU information in schema.org format with various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • catalogId
  • projectId
  • productId
  • x-api-key
  • x-version
  • locale
getProjectNote This tool retrieves a project note using the provided project note ID and associated parameters.
  • x-collection-id
  • catalogId
  • projectId
  • identifier
  • x-auth-token
  • x-api-key
  • x-version
  • locale
getModelValue_1 This tool retrieves model value information by attribute name within a catalog collection using specified path and query parameters.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • modelId
  • modelValueId
  • attributeName
  • x-api-key
  • x-version
  • locale
deleteModelValueAttribute This tool deletes a model value based on a specified attribute name, requiring unique IDs for catalog, project, model, and model value.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • modelId
  • modelValueId
  • attributeName
  • x-api-key
  • x-version
  • locale
getModelValue_2 This tool retrieves all model values from a catalog collection using specified parameters and handles various response statuses.
  • x-auth-token
  • x-collection-id
  • catalogId
  • projectId
  • x-api-key
  • x-version
  • modelId
  • locale
  • filters
  • sort
  • page
  • size
getCatalogRevision This tool retrieves a catalog revision using specified path and query parameters, with detailed error responses for various status codes.
  • x-auth-token
  • x-collection-id
  • catalogId
  • itemId
  • itemType
  • x-api-key
  • x-version
  • locale
getCatalogRevisions This tool retrieves catalog revisions based on input parameters like filters, sorting, pagination, and locale, with detailed response codes for various outcomes.
  • x-auth-token
  • x-collection-id
  • catalogId
  • x-api-key
  • x-version
  • sort
  • filters
  • page
  • size
  • locale
getCatalogReport This tool generates various reports based on the `reportType` parameter, with options for date range, pagination, and summary details, defaulting to the last 7 days.
  • x-auth-token
  • catalogID
  • reportType
  • summary
  • pagination
  • x-collection-id
  • x-api-key
  • fromDate
  • toDate
  • page
  • size
  • projectID
  • locale
cacheClear_2 This tool clears cached data based on specified parameters and provides detailed response codes for various outcomes.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • locale
  • x-version
  • cacheKey

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): Created
202 Accepted
204 (Success): No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
422 Unprocessable Entity
500 Internal Server Error

Useful Resources

Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added