ShipHero MCP Server

ShipHero MCP Server

A comprehensive Model Context Protocol (MCP) server for interacting with the ShipHero API.

## Features

- Complete coverage of ShipHero API endpoints
- Authentication handling with automatic token refresh
- Rate limiting support
- Comprehensive error handling
- Documentation resources

## Installation

```bash
npm install shiphero-mcp-server
```

## Configuration

Create a `.env` file with your ShipHero API credentials:

```
SHIPHERO_API_KEY=your_api_key_here
SHIPHERO_API_SECRET=your_api_secret_here
```

## Usage

### Running the server

```bash
npx shiphero-mcp
```

### Testing with MCP Inspector

```bash
npx @modelcontextprotocol/inspector npx shiphero-mcp
```

## Available Tools

### Orders
- `get_order`: Retrieve a specific order by ID
- `list_orders`: List orders with optional filtering
- `create_order`: Create a new order
- `update_order`: Update an existing order
- `cancel_order`: Cancel an order

### Products
- `get_product`: Retrieve a specific product by ID
- `list_products`: List products with optional filtering
- `create_product`: Create a new product
- `update_product`: Update an existing product
- `delete_product`: Delete a product

### Inventory
- `get_inventory`: Get inventory levels for a product
- `adjust_inventory`: Adjust inventory levels
- `list_inventory_movements`: List inventory movements
- `get_inventory_by_location`: Get inventory by warehouse location

### Shipping
- `get_shipment`: Retrieve a specific shipment by ID
- `list_shipments`: List shipments with optional filtering
- `create_shipment`: Create a new shipment
- `get_shipping_rates`: Get shipping rates for a package
- `create_return`: Create a return shipment

### Warehouses
- `list_warehouses`: List all warehouses
- `get_warehouse`: Get details for a specific warehouse
- `list_locations`: List locations within a warehouse

### Vendors
- `list_vendors`: List all vendors
- `get_vendor`: Get details for a specific vendor
- `create_vendor`: Create a new vendor
- `update_vendor`: Update an existing vendor

### Webhooks
- `list_webhooks`: List all webhook subscriptions
- `create_webhook`: Create a new webhook subscription
- `delete_webhook`: Delete a webhook subscription

## Documentation Resources

Access documentation through the `shiphero://docs/{section}` resource, where `{section}` can be:
- `overview`: General API overview
- `orders`: Orders API documentation
- `products`: Products API documentation
- `inventory`: Inventory API documentation
- `shipping`: Shipping API documentation
- `warehouses`: Warehouses API documentation
- `vendors`: Vendors API documentation
- `webhooks`: Webhooks API documentation

## License

MIT