MCP Server and Resource Metrics
- Server URL:
https://<domain>/inventory/mcp - Total Tools: 46
- Total Error Codes: 12
Server Overview
The MCP server offers a robust suite of 46 tools designed to manage inventory, collections, bins, transactions, caching, and user privileges, enabling efficient organization, real-time updates, and comprehensive reporting for streamlined business operations.
Tools
The following table lists the available MCP tools for Inventory service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| loadInventoryRule | This tool retrieves the inventory rule details for a specified ID in a collection, with various response codes indicating success or errors. |
|
None |
| updateInventoryRule | This tool updates the inventory rule of a specified ID in a collection, returning success or error responses based on request validity. |
|
|
| deleteInventoryRule | This tool deletes an inventory rule by ID from a collection, returning success or error responses based on the request’s validity. |
|
None |
| getCollection | This tool loads a collection based on its identifier, with parameters and responses detailing its operation and errors. |
|
|
| updateCollection | This tool updates a collection by its ID, requiring name, description, and status while disallowing updates to collectionId and businessId. |
|
|
| updateCollectionProperties | This tool updates a property by name within a specified collection ID, requiring mandatory attributes “name” and “value,” with “name” being immutable. |
|
|
| patchUpdateCollectionProperties | This tool updates a collection property by name using collection and business identifiers, with mandatory name and value attributes, while handling various response codes. |
|
|
| getBin | This tool retrieves bin details based on a unique bin name, supporting parent-child bin relationships and user privileges. |
|
|
| updateBin | This tool updates bin attributes, organizes items or child bins, and provides responses via the Bin model with detailed status and validation properties. |
|
|
| deleteBin | This tool deletes a bin by name, removing associated child bins, items, and transactions, with responses indicating success, invalid values, or resource not found. |
|
|
| patchBin | This tool updates bin attributes based on user privileges, with responses provided through the Bin model. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data, and uses `keyName` and `resetRequired` parameters. |
|
None |
| findAllInventoryRule | This tool retrieves inventory rules from a collection and provides responses for success, invalid values, conflicts, or invalid requests. |
|
None |
| createInventoryRule | This tool creates an inventory rule within an inventory collection, requiring mandatory fields like `name`, `processName`, and `rule`, with responses indicating success, invalid values, conflicts, or invalid requests. |
|
|
| 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. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and returns a JSON response with code, message, and timestamp upon success. |
|
|
| getCollections | This tool retrieves Inventory collections based on a search term with pagination, filtering, and various response codes. |
|
|
| createCollection | This tool manages Inventory collections by updating existing properties or using defaults, with specific response codes for success or errors. |
|
|
| createTransactions | This tool facilitates bulk transactions for managing bin items’ inventory using various transaction types, with responses indicating success, validation errors, or resource issues. |
|
|
| getBins | This tool retrieves bins from a collection, optionally filtered by parameters like page, size, and attributes, and returns results in a paginated JSON format. |
|
|
| createBin | This tool allows privileged users to create bins for organizing items or child bins under parent bins, with detailed responses and error handling. |
|
|
| getBinItems | This tool retrieves bin items based on collection ID and filter query, supports pagination, sorting, and filtering, and returns results via the BinItem model array. |
|
|
| createBinItem | This tool allows privileged users to create new bin items using the BinItem model, with detailed response codes and properties for success or errors. |
|
|
| getTransactions | This tool retrieves transactions for bin items based on collectionId, binItemId, and filters, supports various transaction types, and provides paginated JSON responses. |
|
|
| createTransaction | This tool facilitates transactions for bin items, supporting ADD, REMOVE, TRANSFER, and RECONCILE types, with detailed response models and error handling. |
|
|
| checkInventory | This tool determines the inventory status of bin items based on ATP quantity rules and provides responses via the CheckInventory model. |
|
|
| getTransaction | This tool manages inventory transactions by type (ADD, REMOVE, TRANSFER, RECONCILE) for bin items, with detailed properties and responses. |
|
|
| patchTransaction | This tool updates transaction attributes with mandatory notes, supports various transaction types, and returns responses based on success, errors, or conflicts. |
|
|
| getBinItem | This tool retrieves detailed information about a bin item using its unique ID and returns it via the BinItem model. |
|
|
| patchBinItem | This tool updates bin item attributes and returns the updated bin item in the BinItem model, requiring user privileges for modifications. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, cleans instance data, and uses `keyName` and `resetRequired` parameters for AWS call updates. |
|
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 |
| getBinItemByBinNameAndSkuId | This tool retrieves bin item details by bin name and SKU ID in schema.org format, accessible to users with viewing privileges. |
|
|
| findAllBinItemsBySkuId | This tool retrieves bin items by SKU ID, organizing them in schema.org format for users with viewing privileges. |
|
|
| 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 missing resources. |
|
None |
| getAllPrivileges | This tool retrieves all service privileges listed in `roles_privileges.json` and returns them in JSON format upon success. |
|
None |
| getAllPrivilegeGroups | This tool fetches and filters privilege groups and their privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool checks the availability of the Inventory service and returns status codes with JSON responses. |
|
None |
| getInventoryReport | This tool generates various reports based on the `reportType` parameter, with options for filtering, summaries, and a default 7-day range. |
|
|
| getCacheValue | This tool retrieves cached data for a service using a specified string-type 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 |
| getCollectionProperty | This tool retrieves a collection property by name using specified identifiers and parameters, returning success or error responses. |
|
|
| getCollectionProperties | This tool retrieves all collection attributes for Inventory collections, requiring a business ID and optional locale, with responses indicating success, errors, or forbidden access. |
|
|
| getBinItemByBinNameAndSkuId_1 | This tool retrieves bin items by bin name and SKU ID in schema.org format, providing detailed properties and statuses for inventory management. |
|
|
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 |
| 202 | (Success): success |
| 204 | No results found |
| 206 | Success |
| 400 | The request have invalid values |
| 401 | The request is unauthorized |
| 403 | Forbidden |
| 404 | The resource you are trying to reach is not found |
| 409 | The request could not be completed due to a conflict with the current state of the target resource |
| 422 | Invalid request |
| 500 | Internal Server error |
Useful Resources
- API Specifications: API Endpoints – Inventory
- Services Details: Inventory Service
- Video: Infosys Equinox: Inventory MCP Demo
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added