MCP Server and Resource Metrics

  • Server URL: https://<domain>/tax/mcp
  • Total Tools: 33
  • Total Error Codes: 10

Server Overview

The MCP server offers a robust suite of 33 tools designed to manage collections, transactions, tax calculations, caching, and user privileges, enabling seamless integration, efficient data handling, and enhanced microservice functionality for businesses.

Tools

The following table lists the available MCP tools for Tax 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 if required parameters are missing.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • locale
updateCollection This tool updates collection properties based on business and collection IDs, requiring a mandatory field name in the request, with various response codes indicating success or errors.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • locale
replacePropertiesByCollectionId This tool updates collection properties based on mandatory field input, with various response codes indicating success or errors.
  • x-auth-token
  • collectionId
  • businessId
  • x-api-key
  • x-version-id
  • locale
updatePropertiesByCollectionId This tool patch updates collection properties, requiring a mandatory field name, and provides responses for various status codes.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • locale
createTransaction This tool generates transaction details like currency, delivery address, and tax specifics for a tax item.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • value
  • transactionType
  • taxItemId
  • x-version
  • locale
  • id
  • Status
  • responseCode
  • responseMessage
  • properties
  • createdBy
  • createdtime
  • updatedBy
  • updatedTime
  • tax
createTaxItem This tool creates a tax item with tax details, assigns a tax item ID to order details, and provides responses for various statuses.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • value
  • currencyCode
  • x-version
  • locale
  • id
  • profileId
  • provider
  • createdBy
  • createdtime
  • updatedBy
  • updatedtime
  • properties
calculateTax This tool calculates tax methods and values based on parameters like calculation type, locale, and profile ID, with detailed responses for various status codes.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • taxId
  • taxType
  • currency
  • itemDetails
  • shippingPrice
  • shippingDiscount
  • x-version
  • calculationType
  • locale
  • profileId
  • deliverToAddress
  • deliverFromAddress
  • billingAddress
  • properties
  • taxDetails
  • shippingTaxationId
refreshApi This tool sets secret keys without restart, clears instance data for updated AWS calls, requiring `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
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 code, message, and timestamp.
  • x-api-key
  • cacheNames
  • cacheKey
  • simpleKey
  • pattern
findAllCollection This tool retrieves collections based on a mandatory business ID, with optional sorting, filtering, pagination, and locale parameters, returning JSON responses for various status codes.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version-id
  • sort
  • filters
  • locale
  • page
  • size
createCollection This tool initializes a collection with mandatory properties for microservices, requiring a valid `businessId` and `CollectionRequest` field name, while providing detailed responses for various HTTP status codes.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version-id
  • locale
getTransaction This tool retrieves transaction details based on a transaction ID, accessible only to authorized roles, and returns responses in a structured Transaction model.
  • x-auth-token
  • x-collection-id
  • transactionId
  • x-api-key
  • version
  • locale
deleteTransaction This tool deletes a transaction using a valid transaction ID, requiring specific user privileges, and returns a response in JSON format with error codes and messages.
  • x-collection-id
  • x-auth-token
  • transactionId
  • x-api-key
  • x-version
  • locale
getTransaction_1 This tool allows privileged users to update tax item fields (excluding IDs) within transactions, returning responses in the Tax Item model.
  • x-auth-token
  • x-collection-id
  • x-is-reconciliation
  • transactionId
  • x-api-key
  • value
  • transactionType
  • taxItemId
  • version
  • locale
  • properties
getTaxItem This tool retrieves tax item details by ID, supports locale-based responses, and provides various status codes for success or errors.
  • x-auth-token
  • x-collection-id
  • taxItemId
  • x-api-key
  • x-version
  • locale
deleteTaxItem This tool deletes a tax item by ID, including child entities, with access restricted to privileged users and specific roles.
  • x-collection-id
  • x-auth-token
  • taxItemId
  • x-api-key
  • x-version
  • locale
updateTaxItem This tool allows privileged users to update tax item fields except IDs, with responses detailed in the Tax Item model.
  • x-collection-id
  • x-auth-token
  • taxItemId
  • x-api-key
  • profileId
  • value
  • currencyCode
  • properties
  • x-version
  • locale
getTransactions This tool retrieves transactions from a collection using mandatory TaxItemId and CollectionId, with detailed responses for success or errors.
  • x-auth-token
  • x-collection-id
  • taxItemId
  • x-api-key
  • x-version-id
  • locale
  • page
  • size
  • filter
refreshApi_1 This tool updates secret keys without a restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
rabbitMQUpdateCredentials This tool updates RabbitMQ credentials, cleans instance data, and requires keyName and resetRequired parameters for operation.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
refreshApi_2 This tool updates secret keys without restart, clears instance data for AWS calls, and uses keyName and resetRequired parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
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.
  • x-auth-token
  • x-api-key
  • roleName
getReleaseDefinition This tool retrieves the release definition of a service with detailed response codes and properties for various status scenarios.
  • x-auth-token
  • x-api-key
None
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
ping This tool provides a millisecond timestamp to confirm service availability.
  • 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 regex pattern, defaulting to ‘*’.
  • pattern
  • x-auth-token
  • x-api-key
None
getPropertyByCollectionId
AndPropertyName
This tool retrieves collection property details based on a mandatory property name and collection ID, with various response codes for success or errors.
  • x-auth-token
  • businessId
  • collectionId
  • propertyName
  • x-api-key
  • x-version-id
  • locale
findAllCollectionProperties This tool retrieves collection attributes for a microservice, with query parameters for business ID and locale, and provides structured responses for various status codes.
  • x-auth-token
  • businessId
  • locale
  • x-api-key
  • x-version-id
clearCacheByKey This tool clears the tax cache by key using a unique tax ID and supports locale-specific responses.
  • x-collection-id
  • x-auth-token
  • taxId
  • x-api-key
  • x-version
  • locale
clearAllCache This tool clears the tax cache and provides detailed tax information in various response scenarios.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • x-version
  • 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): Success
400 Bad Request
401 Unauthorized
403 Forbidden
404 the resource you are trying to reach is not found
409 Conflict Request
417 Expectation failed
422 Invalid request
500 Internal Server Error occurred

Useful Resources

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