MCP Server and Resource Metrics

  • Server URL: https://<domain>/location/mcp
  • Total Tools: 42
  • Total Error Codes: 11

Server Overview

The MCP server provides a robust suite of 42 tools enabling efficient management of locations, events, collections, caching, and privileges, offering advanced capabilities for data retrieval, updates, creation, and deletion, with customizable parameters and detailed response handling to support diverse business needs.

Tools

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

Tool Name Tool Description Required Parameters Optional Parameters
replaceLocationProperties This tool updates location properties based on a locationId and returns responses in various formats depending on the outcome.
  • x-auth-token
  • x-collection-id
  • locationId
  • x-api-key
  • x-version
  • locale
updateLocationProperties This tool updates location properties using a locationId and supports various response codes for success or errors.
  • x-auth-token
  • x-collection-id
  • locationId
  • x-api-key
  • x-version
  • locale
getLocation This tool retrieves location details using a unique location ID and supports various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • x-version
  • locale
replaceLocation This tool updates location data using path and query parameters, returning various responses based on success or error conditions.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • status
  • x-version
  • locale
  • identifier
  • collectionId
  • name
  • address
  • images
  • hours
  • events
  • properties
  • binId
  • enableShipToStore
  • enableStorePickup
  • enableShipFromStore
  • locationType
deleteLocation This tool deletes a location using a unique location ID and provides responses based on the operation’s outcome.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • x-version
  • locale
updateLocation This tool updates location data based on provided parameters and returns detailed responses for various status codes.
  • x-collection-id
  • x-auth-token
  • id
  • x-api-key
  • status
  • x-version
  • locale
  • identifier
  • collectionId
  • name
  • address
  • images
  • hours
  • events
  • properties
  • binId
  • enableShipToStore
  • enableStorePickup
  • enableShipFromStore
  • locationType
getEvent This tool retrieves event details based on a given location ID, supporting locale-specific responses and various error codes.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
replaceEvent This tool updates event data using path and query parameters, with various response codes indicating success or errors.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
deleteEvent This tool deletes an event using a specified location ID and provides various response codes based on the operation’s outcome.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
updateEvent This tool updates event data using path and query parameters, with various response codes indicating success or errors.
  • x-auth-token
  • x-collection-id
  • id
  • x-api-key
  • x-version
  • locale
getCollection This tool retrieves a collection based on a specified collection ID and provides responses for various status codes.
  • 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 and parameters.
  • x-auth-token
  • businessId
  • id
  • x-api-key
  • x-version
  • locale
replaceCollectionProperties This tool updates all properties within a specified collection based on provided identifiers and parameters.
  • x-auth-token
  • id
  • businessId
  • x-api-key
  • x-version
  • locale
updateCollectionProperties This tool updates properties of a specified collection within a microservice, with responses varying based on success or error codes.
  • x-auth-token
  • businessId
  • id
  • x-api-key
  • x-version
  • locale
refreshApi This tool updates secret keys without restart, clears instance data, and provides detailed response codes for various statuses.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
 None
getLocations This tool retrieves active and inactive locations with pagination, sorting, filtering, and locale options, returning detailed responses for success or errors.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • locale
createLocation This tool creates a location in a collection and provides detailed responses for success, errors, and status codes.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • status
  • x-version
  • locale
  • identifier
  • collectionId
  • name
  • address
  • images
  • hours
  • events
  • properties
  • binId
  • enableShipToStore
  • enableStorePickup
  • enableShipFromStore
  • locationType
getEvents This tool retrieves active and inactive events 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
  • page
  • size
  • locale
createEvent This tool creates an event in a collection and provides responses based on success or error codes.
  • 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 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 provides detailed response codes and messages for various HTTP statuses.
  • x-api-key
  • cacheNames
  • cacheKey
  • simpleKey
  • pattern
getCollections This tool retrieves collections with support for pagination, filtering, sorting, and locale-specific responses.
  • x-auth-token
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • businessId
  • locale
createCollection This tool creates a collection based on the provided collection request and returns responses for various statuses like success, unauthorized, forbidden, and errors.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
getStates This tool retrieves active and inactive states with configurable query parameters and detailed response codes.
  • x-auth-token
  • x-api-key
  • page
  • size
  • sort
  • filters
  • locale
refreshApi_1 This tool updates secret keys without restart, cleans instance data, and uses `keyName` and `resetRequired` parameters for AWS calls.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
 None
rabbitMQUpdateCredentials This tool updates RabbitMQ credentials, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters, with detailed response codes for various outcomes.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
 None
getAllStandrdRoles This tool retrieves and filters standard roles with associated privileges, 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 various response codes indicating success or errors.
  • 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 their privileges from a JSON file based on the `privilegeGroupName` parameter, with detailed response codes for various scenarios.
  • x-auth-token
  • x-api-key
  • privilegeGroupName
getPlaces This tool retrieves active and inactive places with customizable query parameters and detailed response codes.
  • x-auth-token
  • x-api-key
  • page
  • size
  • sort
  • filters
  • locale
ping This tool provides the current date and time to check service availability and returns detailed response codes for various statuses.
  • x-api-key
 None
getLocations_1 This tool retrieves active and inactive locations with pagination, proximity, and locale options, returning detailed responses for various status codes.
  • x-collection-id
  • x-auth-token
  • latitude
  • longitude
  • x-api-key
  • x-version
  • proximity
  • distantUnit
  • page
  • size
  • locale
getDistinctLocations This tool retrieves active and inactive distinct locations from a collection with customizable query, pagination, and sorting options.
  • x-collection-id
  • x-auth-token
  • addressField
  • x-api-key
  • x-version
  • page
  • size
  • sort
  • filters
  • locale
exportLocationSheet The tool allows exporting location lists by ID with various response codes for success or errors, supporting locale-specific responses.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • importExportType
  • locale
  • x-version
getCountries This tool retrieves active and inactive countries with customizable query parameters and detailed response codes.
  • x-auth-token
  • x-api-key
  • page
  • size
  • sort
  • filters
  • locale
getCacheValue This tool retrieves cached data for a service using a string-based cache name and key, with detailed response codes and examples provided.
  • 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, with default as ‘*’.
  • pattern
  • x-auth-token
  • x-api-key
 None
getCollectionPropertiesByName This tool retrieves a specified collection property using collection and business identifiers, with responses for various status codes.
  • x-auth-token
  • businessId
  • id
  • name
  • x-api-key
  • x-version
  • locale
getCollectionAttributes This tool retrieves all collection attributes and provides responses based on query parameters and status codes.
  • x-auth-token
  • x-api-key
  • x-version
  • businessId
  • locale
getCities This tool retrieves active and inactive cities with customizable query parameters and detailed response codes.
  • x-auth-token
  • x-api-key
  • page
  • size
  • sort
  • filters
  • locale
cacheClear_2 This tool clears cached data based on specified parameters and provides various response codes for success or errors.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • locale
  • x-version
  • cacheKey

Error Responses

Error Code Error Description
200 Success
201 (Success): Created
202 (Success): Accepted
204 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