MCP Server and Resource Metrics

  • Server URL: https://<domain>/ratingsreviews/mcp
  • Total Tools: 41
  • Total Error Codes: 10

Server Overview

The MCP server offers a robust suite of 41 tools designed for managing collections, questions, answers, ratings, reviews, caching, and user privileges, enabling seamless integration, data handling, and enhanced microservice functionality for businesses.

Tools

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

Tool Name Tool Description Required Parameters Optional Parameters
UpdateAllAnswers This tool updates all answers of a question based on the provided question ID and locale, with various response codes indicating success or errors.
  • collectionId__header
  • x-auth-token
  • questionId__path
  • x-api-key
  • locale
  • collectionId
  • questionId
  • answers
CreateAnswerForQuestion This tool generates answers for a given question based on specified parameters and returns responses in JSON format.
  • collectionId__header
  • questionId__path
  • x-auth-token
  • x-api-key
  • locale
  • collectionId
  • questionId
  • answers
getCollectionById This tool retrieves collection details and properties based on business and collection IDs, throwing errors if required parameters are missing.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • x-store-id
  • locale
replaceCollectionById This tool updates collection properties based on business and collection IDs, requiring a mandatory field name in the request, or it throws an error.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • x-store-id
  • locale
replacePropertiesByCollectionId This tool updates collection properties, requiring a mandatory field name and valid identifiers, with responses ranging from success to various error codes.
  • x-auth-token
  • collectionId
  • businessId
  • x-api-key
  • x-version-id
  • x-store-id
  • locale
updatePropertiesByCollectionId This tool patch updates collection properties, requiring a mandatory field name, with various response codes for success or errors.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • x-store-id
  • locale
CreateQuestionsAndAnswers This tool generates a question and its answers based on item and locale parameters, returning various response codes for success or errors.
  • collectionId__header
  • itemId__path
  • x-auth-token
  • x-api-key
  • locale__query
  • collectionId
  • itemId
  • locale
  • questionsAndAnswers
createVotes This tool enables creating like or unlike votes for answers to questions with detailed responses based on status codes.
  • collectionId__header
  • x-auth-token
  • x-api-key
  • locale
  • collectionId
  • questionId
  • answersId
  • userId
  • voteType
refreshApi This tool updates secret keys without restarting, clears instance data for AWS calls, and uses `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
GetAllRatingsandReviews This tool retrieves ratings and reviews with optional hashtags or summaries, requiring specific apps and query flags for customization.
  • x-version-id
  • collectionId
  • x-api-key
  • x-auth-token
  • x-store-id
  • sort
  • filters
  • locale
  • page
  • size
  • skipTotalCount
  • enableReviewSummary
  • enableHashtags
CreateRatingandReview This tool enables customers to post ratings, reviews, and images for items, with automatic sentiment classification when the required app is installed.
  • collectionId
  • x-auth-token
  • x-api-key
  • userId
  • x-store-id
  • locale
  • itemId
  • rating
  • review
  • status
  • properties
  • updatedBy
  • reviewtitle
  • classification
  • remarks
UpdateImagesRatingandReview This tool updates images associated with a rating and review, using specified parameters and providing detailed response statuses.
  • collectionId
  • x-auth-token
  • id
  • x-api-key
  • userId
  • x-store-id
  • locale
  • files
CreateReviewFeedback This tool generates review feedback based on a given rating and review ID, with responses varying by status codes.
  • x-auth-token
  • ratingid
  • x-api-key
  • locale
  • userid
  • x-store-id
  • feedback
  • properties
updateReviewFeedback This tool updates review feedback attributes and provides responses in JSON format with details like ID, feedback type, timestamps, and user info.
  • x-auth-token
  • id
  • x-api-key
  • userid
  • locale
  • x-store-id
  • feedback
  • properties
cacheClear This tool clears cached data for specified cache names, supports string-type keys, and clears all 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 returns a JSON response with a code, message, and timestamp.
  • x-api-key
  • cacheNames
  • cacheKey
  • simpleKey
  • pattern
getCollections This tool retrieves collections based on a mandatory business ID, with optional sorting, filtering, pagination, and locale parameters, returning various status codes for success or errors.
  • x-version-id
  • x-auth-token
  • businessId
  • x-api-key
  • x-store-id
  • sort
  • filters
  • locale
  • page
  • size
createCollection This tool initializes a collection with defined properties for microservices, requiring mandatory fields in the request body and supporting various response codes for validation and errors.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version-id
  • x-store-id
  • locale
GetRatingandReviewbyID This tool retrieves a rating and review using collection ID, user ID, and review ID, with locale-based responses and detailed metadata.
  • x-auth-token
  • x-version-id
  • collectionId
  • id
  • x-api-key
  • userId
  • x-store-id
  • locale
DeleteRatingandReviewbyID This tool deletes a rating and review from a collection using the provided ID and supports locale-specific responses.
  • x-auth-token
  • x-version-id
  • collectionId
  • id
  • x-api-key
  • x-store-id
  • locale
UpdateAttributesRatingandReview This tool updates attributes of a rating and review, with responses based on status codes.
  • x-auth-token
  • x-version-id
  • collectionId
  • id
  • x-api-key
  • x-store-id
  • locale
  • itemId
  • rating
  • review
  • status
  • properties
  • updatedBy
  • reviewtitle
  • classification
  • remarks
GetAllQuestions This tool retrieves all questions and answers for a specified item with customizable query parameters and paginated responses.
  • collectionId
  • x-auth-token
  • x-api-key
  • locale
  • itemId
  • filters
  • page
  • size
UpdateQuestionStatus This tool updates the status of provided questions and responds with various HTTP status codes based on the outcome.
  • x-auth-token
  • x-version-id
  • collectionId
  • x-api-key
  • x-store-id
  • locale
UpdateAnswerStatus This tool updates the status of specified answers using questionId and locale parameters, with various response codes indicating success or errors.
  • x-auth-token
  • collectionId
  • questionId
  • x-version-id
  • x-api-key
  • x-store-id
  • locale
GetVotes This tool retrieves the count of like and unlike votes for a specific answer based on provided question, user, and vote details.
  • collectionId
  • questionId
  • answerId
  • userId
  • x-auth-token
  • voteType
  • x-api-key
  • locale
refreshApi_1 This tool updates secret keys without restarting, clears instance data for AWS calls, and uses keyName and resetRequired parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
rabbitMQUpdateCredentials This tool updates RabbitMQ credentials, cleans instance data for AWS calls, and requires keyName and resetRequired parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
refreshApi_2 This tool sets secret keys without restart, updates AWS call values, and uses `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
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.
  • x-auth-token
  • x-api-key
  • roleName
getReleaseDefinition This tool retrieves the release definition of a service and provides structured responses for success, errors, or resource issues.
  • x-auth-token
  • x-api-key
None
GetRatingsSummary This tool summarizes ratings data, supports sorting, filtering, pagination, and provides responses for various statuses.
  • collectionId
  • x-auth-token
  • x-api-key
  • x-version-id
  • x-store-id
  • sort
  • filters
  • locale
  • page
  • size
GetAllQuestions_1 This tool retrieves answers for a given question using parameters like locale, sorting, filters, pagination, and returns responses with status codes.
  • collectionId
  • x-auth-token
  • questionId
  • x-api-key
  • locale
  • sort
  • filters
  • page
  • size
GetQuestionsAndAnswersbyID This tool retrieves a question and its answers using a provided `questionId`, with responses in various statuses.
  • collectionId
  • x-auth-token
  • questionId
  • x-api-key
  • locale
DeleteQuestionsbyID This tool deletes a question using the provided `questionId` and supports locale-specific responses.
  • collectionId
  • x-auth-token
  • questionId
  • x-api-key
  • locale
getAllPrivileges This tool fetches service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning them as JSON upon success.
  • 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.
  • x-auth-token
  • x-api-key
  • privilegeGroupName
ViewPingResponse This tool returns a timestamp to confirm service availability, with responses indicating success or resource not found.
  • x-api-key
None
getCacheValue This tool retrieves cached data for a service using a specified string-based cache name and cache key.
  • cacheName
  • cacheKey
  • x-auth-token
  • x-api-key
None
getCacheKeys This tool retrieves cache keys for a service using a specified Redis-supported pattern, defaulting to ‘*’.
  • pattern
  • x-auth-token
  • x-api-key
None
getPropertyByCollectionId
AndPropertyName
This tool retrieves a mandatory collection property by name for a specified collection, throwing an error if the name is missing.
  • x-auth-token
  • businessId
  • collectionId
  • name
  • x-api-key
  • x-version-id
  • x-store-id
  • locale
getCollectionAttributes This tool retrieves collection attributes for a microservice, detailing properties like defaultValue, description, name, nullable, and type, with responses for various HTTP status codes.
  • x-version-id
  • x-auth-token
  • businessId
  • x-api-key
  • x-store-id
  • locale

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 (Success): Accepted
400 Bad Request
401 Unauthorized
403 Forbidden
404 The resource you are trying to reach is not found
409 Conflict Request
422 Unprocessable Entity
500 Internal Server Error occurred.

Useful Resources

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