Skip to main content

ShipBoss MCP server with parcel & freight endpoints

Project description

ShipBoss MCP Server

An MCP server that provides shipping and logistics capabilities through AI conversations. Connect to FedEx, UPS, and DHL to get rates, create labels, track packages, and manage freight shipments.

🚀 Quick Setup (5 Minutes)

Prerequisites

  • Python 3.9+ installed
  • ShipBoss account with API token (get one in the admin section at ship.shipboss.io)

Step-by-Step Installation

Step 1: Get Your ShipBoss API Token

  1. Go to ShipBoss
  2. Go to your Admin section → API Integrations
  3. Generate a new API token and copy it

Step 2: Install the Package

# Install from PyPI (recommended)
pip install shipboss-mcp-server

# Or install in a virtual environment
python -m venv shipboss_env

# Windows:
shipboss_env\Scripts\activate
# macOS/Linux:
source shipboss_env/bin/activate

pip install shipboss-mcp-server

Step 3: Configure MCP Server Choose one of these methods to provide your API token:

Option A: .env File (Simplest - Automatic)

# Create environment file in your current directory
echo "SHIPBOSS_API_TOKEN=your_api_token_here" > .env

Then use this simple configuration (the .env file will be loaded automatically):

{
  "mcpServers": {
    "shipboss-mcp": {
      "command": "shipboss-mcp-server"
    }
  }
}

Option B: Command-Line Argument

Add this to your MCP client configuration:

{
  "mcpServers": {
    "shipboss-mcp": {
      "command": "shipboss-mcp-server",
      "args": ["--api-token", "your_api_token_here"]
    }
  }
}

Option C: Environment Variable in Config

Use this configuration with the token in the env section:

{
  "mcpServers": {
    "shipboss-mcp": {
      "command": "shipboss-mcp-server",
      "env": {
        "SHIPBOSS_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Step 4: Test Your Setup Restart your MCP client and try:

  • "Get shipping rates from New York to Los Angeles for a 2lb package"
  • "Create a FedEx Ground label from 123 Main St, New York, NY to 456 Oak Ave, Los Angeles, CA"

Available Tools

  • ping - Health check
  • get_parcel_rates - Get parcel shipping rates
  • create_parcel_label - Create parcel shipping labels with direct download URLs
  • track_parcel - Track parcel shipments
  • create_pickup - Schedule carrier pickups
  • cancel_pickup - Cancel scheduled pickups
  • get_freight_rates - Get freight shipping quotes
  • track_freight - Track freight shipments

Troubleshooting

Common Issues:

  1. "API token required" error: Make sure you have your API token configured using one of these methods:

    • Easiest: Create a .env file with SHIPBOSS_API_TOKEN=your_token (automatically loaded)
    • Add --api-token your_token to the args in your MCP config
    • Set SHIPBOSS_API_TOKEN in the env section of your MCP config
  2. ".env file not found": The .env file should be in your current working directory when running the shipboss-mcp-server command.

  3. "Unexpected token" errors: Make sure the package is properly installed with pip install shipboss-mcp-server.

  4. Command not found: Ensure the package is installed and the shipboss-mcp-server command is available in your PATH.

  5. Permission errors: The installed package should have proper permissions. Try running with python -m shipboss_mcp_server if the command fails.

Debug Mode:

Run the server directly to test:

# Using the installed command:
shipboss-mcp-server --api-token your_token

# Or using python module:
python -m shipboss_mcp_server --api-token your_token

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipboss_mcp_server-4.0.7.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shipboss_mcp_server-4.0.7-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file shipboss_mcp_server-4.0.7.tar.gz.

File metadata

  • Download URL: shipboss_mcp_server-4.0.7.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for shipboss_mcp_server-4.0.7.tar.gz
Algorithm Hash digest
SHA256 0482a280505ed3c805d700e4c4670a807a2292fb8a23f942d3bad760d09dce67
MD5 a9447082029a26b5e1cd7c358bb80c38
BLAKE2b-256 5a00da3a631846d7c80af2c326315702a970801906aa97617a67a4703f20987e

See more details on using hashes here.

File details

Details for the file shipboss_mcp_server-4.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for shipboss_mcp_server-4.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f6c0b538e95adde48d5c6d6bb898124d1d16ccefd328ca0f037c2a9bcb0cf9a5
MD5 d5a23624307ec465811388e1618e8e67
BLAKE2b-256 34b0ae6b24dde82a5bedfb497c4b3274851a9ac3acbe64f9d9d3a77c6f30075e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page