Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| SHIPI_BASE_URL | No | API base URL (default: https://app.myshipi.com) | https://app.myshipi.com |
| SHIPI_INTEGRATION_KEY | Yes | Your Shipi integration key |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_shipments | List shipments with pagination and filters. Filter by status (new/created/delivered), carrier, or date range. |
| get_shipment | Get detailed information about a specific shipment by ID or order ID. Includes shipper, recipient, products, tracking, and label URLs. |
| search_shipments | Search shipments by order ID or tracking number. Returns matching shipments. |
| create_shipment | Create a shipping label. Requires carrier account, shipper/recipient addresses, and product details. Returns tracking number and label URL. |
| cancel_shipment | Cancel a shipment and void its label. Requires the shipment ID (del_ref). |
| get_shipping_rates | Get live shipping rates from all configured carriers. Provide recipient address and package details to compare prices across FedEx, UPS, DHL, USPS, etc. |
| schedule_pickup | Schedule a carrier pickup for a shipment. The carrier will come to the shipper address to collect the package. |
| track_shipment | Get a tracking URL for a shipment. Supports auto-detection of carrier from tracking number format. |
| fetch_labels | Fetch shipping labels for printing. Filter by printed/unprinted status. Returns label URLs. |
| list_addresses | List all saved addresses from the address book. Filter by type (shipper/receiver). |
| get_address | Get a specific address by ID from the address book. |
| add_address | Add a new address to the address book. Used for saving shipper or receiver addresses for reuse. |
| edit_address | Update an existing address in the address book. Only changed fields need to be provided. |
| delete_address | Delete an address from the address book by ID. |
| list_carriers | List all configured shipping carrier accounts. Shows carrier type, primary status, and shipper address. Credentials are never exposed. |
| get_carrier | Get details of a specific carrier account by ID. Returns carrier type and shipper address info. |
| get_account_info | Get Shipi account information including user details, store info, billing/balance, plan, and feature flags. |
| get_shipping_stats | Get shipping statistics and analytics. View shipment counts, cost breakdowns, carrier usage, tracking status, and daily trends. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |