MCP Server and Resource Metrics
- Server URL:
https://<domain>/oms/mcp - Total Tools: 39
- Total Error Codes: 13
Server Overview
The MCP server provides a robust suite of tools designed for efficient order and collection management, enabling operations like retrieval, creation, updating, deletion, caching, notifications, and reporting, while supporting advanced filtering, sorting, and integration capabilities to streamline business workflows and enhance operational efficiency.
Tools
The following table lists the available MCP tools for Order service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| Get_order | This tool retrieves order details using a unique order ID and collection ID, with optional archive database inclusion. |
|
|
| Create_order | This tool updates an order for a specific collection based on valid request details, returning various responses depending on success or errors. |
|
|
| Delete_order | This tool deletes an order linked to a collection using valid order and collection IDs, returning various response codes based on the operation’s outcome. |
|
|
| Patch_order | This tool updates order or item details based on order ID, allowing status changes or approvals but not both simultaneously. |
|
|
| Get_collection | This tool retrieves a collection using a valid collection ID and supports various response codes for success or errors. |
|
|
| Update_collection | This tool updates an OMS collection by modifying all attributes, requiring all associated properties to be included in the request. |
|
|
| Update_collection_properties | This tool updates all collection properties based on specified identifiers and parameters, returning various response codes for success or errors. |
|
|
| Update_collection_property | This tool updates one or more collection properties based on specified parameters and returns various response codes. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS updates, and uses `keyName` and `resetRequired` parameters. |
|
None |
| Get_Orders | This tool retrieves orders based on a collection identifier, with various query parameters for pagination, filtering, sorting, and database selection, returning detailed order information in JSON format. |
|
|
| Create_order_1 | This tool creates an order for a specific collection based on valid request details, returning various responses depending on success or errors. |
|
|
| Create_notes | This tool creates a note for a specific order linked to a collection, with the request formatted as Note JSON and responses detailing order-related properties. |
|
|
| cacheClear | This tool clears cached data by cache name(s), supports string-type keys, and can clear all cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and provides a JSON response with code, message, and timestamp upon success. |
|
|
| Get_collections | This tool retrieves OMS collections with query parameters for filtering, pagination, and sorting, returning various HTTP response codes based on the request outcome. |
|
|
| Create_collection | This tool creates an OMS collection with specified properties, requiring a valid business ID and returning various response codes based on request validity. |
|
|
| Update_Notification | This tool updates notifications for a specific order within a collection using a Note and Notification JSON, with detailed response codes and properties. |
|
|
| Patch_Locked_order | This tool updates order details or item status based on order ID, allowing one operation at a time with eligibility checks and various response codes for success or errors. |
|
|
| Patch_Message_resend | This tool pushes messages to a specified queue using orderId and queueName as parameters, with various response codes detailing outcomes. |
|
|
| Get_collection_property | This tool retrieves a collection property value by name using specified identifiers and parameters. |
|
|
| Update_collection_property_1 | This tool patch modifies a specified collection property attribute by name using collection and business identifiers. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS updates, and requires keyName and resetRequired parameters. |
|
None |
| refreshApi_2 | This tool updates secret keys without restarting, cleans instance data for AWS updates, and uses `keyName` and `resetRequired` parameters. |
|
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. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of the service with detailed response codes and properties. |
|
None |
| getAllPrivileges | This tool retrieves service privileges listed in `roles_privileges.json` and returns them in JSON format upon success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool returns a timestamp in milliseconds to confirm service availability. |
|
None |
| Return_Label | This tool generates a shipping label using order ID, collection ID, and item ID, with detailed response codes and properties. |
|
|
| Get_Sku | This tool retrieves all SKUs with their quantities for a user linked to a collection, supporting archive data and various response formats. |
|
|
| Get_Locked_Orders | The tool retrieves locked orders with filtering, pagination, sorting, and detailed response structures, returning appropriate status codes for success or errors. |
|
|
| getOrderReport | This tool generates order reports based on various report types and date ranges, with options to include archived data using specified ZooKeeper properties. |
|
|
| Get_Total_Orders | This tool retrieves all OMS collection attributes based on query parameters, returning responses in JSON format with status codes like 200, 403, or 500. |
|
|
| Get_orders_Summary | This tool retrieves order summary details based on a collection ID, with filtering, sorting, pagination, and varied response codes. |
|
|
| getCacheValue | This tool retrieves cached data for a service using a specified string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| Get_collection_property_1 | This tool retrieves a collection property value by name using specified identifiers and parameters. |
|
|
| Get_Collection_Attributes | This tool retrieves all OMS collection attributes with locale-specific responses and error handling. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | Ok |
| 201 | Success |
| 202 | (Success): Accepted |
| 204 | No content |
| 208 | Already Reported |
| 400 | The request have invalid values |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | The resource you are trying to reach is not found |
| 406 | Not Acceptable |
| 417 | Expectation Failed |
| 422 | Invalid request |
| 500 | Internal Server error |
Useful Resources
- API Specifications: API Endpoints – Order
- Services Details: Order Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added