| Name | ordercloud-mcp JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | MCP server for Order Cloud API integration |
| upload_time | 2025-10-07 08:49:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
api
mcp
ordercloud
server
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OrderCloud MCP
A Model Context Protocol (MCP) server for Order Cloud API integration. This server provides tools for managing orders, customers, and CSR actions through the MCP protocol.
## Features
- 🛒 **Order Management**: Create, read, update, and delete orders
- 📋 **Order Listing**: List orders with pagination and filtering
- 👤 **Customer Orders**: Retrieve all orders for specific customers
- ❌ **Order Cancellation**: Cancel orders with tracking
- 👨💼 **CSR Actions**: Track customer service representative actions
## Installation
```bash
pip install ordercloud-mcp
```
## Usage
### As a Standalone Server
Run with stdio transport (default):
```bash
ordercloud-mcp
```
Run with SSE transport:
```bash
ordercloud-mcp --sse
```
### With Claude Desktop
Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"ordercloud": {
"command": "ordercloud-mcp"
}
}
}
```
### Programmatic Usage
```python
from ordercloud_mcp import mcp
# The server will be available for MCP clients
mcp.run(transport='stdio')
```
## Configuration
The server connects to the Order Cloud API at `http://localhost:3300/api/v1` by default. To change this, modify the `API_BASE` constant in your local installation.
## Available Tools
### `get_order`
Retrieve a single order by ID with all details.
**Parameters:**
- `order_id` (str): UUID of the order
### `list_orders`
Retrieve all orders with pagination.
**Parameters:**
- `page` (int): Page number (default: 1)
- `limit` (int): Orders per page (default: 10)
- `is_active` (bool|None): Filter by active status
### `create_order`
Create a new order with items.
**Parameters:**
- `customer_id` (str): Customer UUID
- `prescription_id` (str): Prescription UUID
- `created_by` (str): Creator UUID
- `order_items` (list): List of order items
- `total_amount` (str|None): Total amount
- `is_payment_done` (bool): Payment status
- `is_active` (bool): Active status
### `delete_order`
Soft delete an order.
**Parameters:**
- `order_id` (str): Order UUID
- `deleted_by` (str): Deleter UUID
### `get_orders_by_customer`
Get all orders for a specific customer.
**Parameters:**
- `customer_id` (str): Customer UUID
### `cancel_order`
Cancel an order.
**Parameters:**
- `order_id` (str): Order UUID
- `cancelled_by` (str): Canceller UUID
### `add_csr_action`
Add a CSR action to an order.
**Parameters:**
- `order_id` (str): Order UUID
- `csr_id` (str): CSR UUID
- `action_type` (str): Type of action
- `old_values` (dict): Previous values
- `new_values` (dict): New values
- `created_by` (str): Creator UUID
## Development
### Setup
```bash
git clone https://github.com/yourusername/ordercloud-mcp.git
cd ordercloud-mcp
pip install -e ".[dev]"
```
### Running Tests
```bash
pytest
```
### Code Formatting
```bash
black src/
ruff check src/
```
## Requirements
- Python 3.10+
- httpx >= 0.24.0
- mcp >= 1.0.0
## License
MIT License - see LICENSE file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Support
For issues and questions, please use the [GitHub Issues](https://github.com/yourusername/ordercloud-mcp/issues) page.
Raw data
{
"_id": null,
"home_page": null,
"name": "ordercloud-mcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api, mcp, ordercloud, server",
"author": null,
"author_email": "Devesh Soni <devesh.soni@thoughtswinsystems.com>",
"download_url": "https://files.pythonhosted.org/packages/db/f0/7ba5a2f0f5b9835b8818c88a649f005c78fa9dd3bbac293f20f2c4580524/ordercloud_mcp-1.0.2.tar.gz",
"platform": null,
"description": "# OrderCloud MCP\n\nA Model Context Protocol (MCP) server for Order Cloud API integration. This server provides tools for managing orders, customers, and CSR actions through the MCP protocol.\n\n## Features\n\n- \ud83d\uded2 **Order Management**: Create, read, update, and delete orders\n- \ud83d\udccb **Order Listing**: List orders with pagination and filtering\n- \ud83d\udc64 **Customer Orders**: Retrieve all orders for specific customers\n- \u274c **Order Cancellation**: Cancel orders with tracking\n- \ud83d\udc68\u200d\ud83d\udcbc **CSR Actions**: Track customer service representative actions\n\n## Installation\n\n```bash\npip install ordercloud-mcp\n```\n\n## Usage\n\n### As a Standalone Server\n\nRun with stdio transport (default):\n```bash\nordercloud-mcp\n```\n\nRun with SSE transport:\n```bash\nordercloud-mcp --sse\n```\n\n### With Claude Desktop\n\nAdd to your `claude_desktop_config.json`:\n\n```json\n{\n \"mcpServers\": {\n \"ordercloud\": {\n \"command\": \"ordercloud-mcp\"\n }\n }\n}\n```\n\n### Programmatic Usage\n\n```python\nfrom ordercloud_mcp import mcp\n\n# The server will be available for MCP clients\nmcp.run(transport='stdio')\n```\n\n## Configuration\n\nThe server connects to the Order Cloud API at `http://localhost:3300/api/v1` by default. To change this, modify the `API_BASE` constant in your local installation.\n\n## Available Tools\n\n### `get_order`\nRetrieve a single order by ID with all details.\n\n**Parameters:**\n- `order_id` (str): UUID of the order\n\n### `list_orders`\nRetrieve all orders with pagination.\n\n**Parameters:**\n- `page` (int): Page number (default: 1)\n- `limit` (int): Orders per page (default: 10)\n- `is_active` (bool|None): Filter by active status\n\n### `create_order`\nCreate a new order with items.\n\n**Parameters:**\n- `customer_id` (str): Customer UUID\n- `prescription_id` (str): Prescription UUID\n- `created_by` (str): Creator UUID\n- `order_items` (list): List of order items\n- `total_amount` (str|None): Total amount\n- `is_payment_done` (bool): Payment status\n- `is_active` (bool): Active status\n\n### `delete_order`\nSoft delete an order.\n\n**Parameters:**\n- `order_id` (str): Order UUID\n- `deleted_by` (str): Deleter UUID\n\n### `get_orders_by_customer`\nGet all orders for a specific customer.\n\n**Parameters:**\n- `customer_id` (str): Customer UUID\n\n### `cancel_order`\nCancel an order.\n\n**Parameters:**\n- `order_id` (str): Order UUID\n- `cancelled_by` (str): Canceller UUID\n\n### `add_csr_action`\nAdd a CSR action to an order.\n\n**Parameters:**\n- `order_id` (str): Order UUID\n- `csr_id` (str): CSR UUID\n- `action_type` (str): Type of action\n- `old_values` (dict): Previous values\n- `new_values` (dict): New values\n- `created_by` (str): Creator UUID\n\n## Development\n\n### Setup\n\n```bash\ngit clone https://github.com/yourusername/ordercloud-mcp.git\ncd ordercloud-mcp\npip install -e \".[dev]\"\n```\n\n### Running Tests\n\n```bash\npytest\n```\n\n### Code Formatting\n\n```bash\nblack src/\nruff check src/\n```\n\n## Requirements\n\n- Python 3.10+\n- httpx >= 0.24.0\n- mcp >= 1.0.0\n\n## License\n\nMIT License - see LICENSE file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Support\n\nFor issues and questions, please use the [GitHub Issues](https://github.com/yourusername/ordercloud-mcp/issues) page.",
"bugtrack_url": null,
"license": "MIT",
"summary": "MCP server for Order Cloud API integration",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/yourusername/ordercloud-mcp",
"Issues": "https://github.com/yourusername/ordercloud-mcp/issues",
"Repository": "https://github.com/yourusername/ordercloud-mcp"
},
"split_keywords": [
"api",
" mcp",
" ordercloud",
" server"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "666bd27bd931b623a7b6d91c447a76016f4bad0875387701f53abc8abe8353c7",
"md5": "27d31a3e9f913de1b0fc39ae6834653f",
"sha256": "064a069dbcbf70a2bad08362d2265646dacc81db2af211625537d3954df8b833"
},
"downloads": -1,
"filename": "ordercloud_mcp-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27d31a3e9f913de1b0fc39ae6834653f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6831,
"upload_time": "2025-10-07T08:49:03",
"upload_time_iso_8601": "2025-10-07T08:49:03.913748Z",
"url": "https://files.pythonhosted.org/packages/66/6b/d27bd931b623a7b6d91c447a76016f4bad0875387701f53abc8abe8353c7/ordercloud_mcp-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dbf07ba5a2f0f5b9835b8818c88a649f005c78fa9dd3bbac293f20f2c4580524",
"md5": "01147b81f55aa1c97b46324cbc3d5b2f",
"sha256": "b2647a951e81a0bcc6ed304ef170baeb552eb47f1db181e02d749f9e58615b8a"
},
"downloads": -1,
"filename": "ordercloud_mcp-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "01147b81f55aa1c97b46324cbc3d5b2f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6185,
"upload_time": "2025-10-07T08:49:05",
"upload_time_iso_8601": "2025-10-07T08:49:05.515007Z",
"url": "https://files.pythonhosted.org/packages/db/f0/7ba5a2f0f5b9835b8818c88a649f005c78fa9dd3bbac293f20f2c4580524/ordercloud_mcp-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-07 08:49:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "ordercloud-mcp",
"github_not_found": true,
"lcname": "ordercloud-mcp"
}
