UPS

Provides an MCP interface for UPS shipping tools, enabling tracking, transit status, and delivery estimates through OAuth-authenticated interactions.

python

11

GitHub Stars

python

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "ups-api-ups-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/UPS-API/ups-mcp",
        "ups-mcp"
      ],
      "env": {
        "CLIENT_ID": "YOUR_CLIENT_ID",
        "ENVIRONMENT": "test",
        "CLIENT_SECRET": "YOUR_CLIENT_SECRET"
      }
    }
  }
}

UPS MCP Server provides a Model Context Protocol interface for integrating UPS shipping and logistics capabilities with AI agents. It enables tracking events, current transit status, and delivery estimates by authenticating with UPS via OAuth credentials you obtain from the UPS Developer Portal. This guide explains how to use, install, and configure the UPS MCP Server for smooth AI-assisted shipping workflows.

How to use

You connect an MCP client to the UPS MCP Server to enable AI agents to perform UPS tracking and address validation tasks. Authenticate using OAuth client credentials you obtain from the UPS Developer Portal. After authentication, you can track packages, view the latest transit information, and retrieve estimated delivery details by issuing MCP requests to the server via your chosen MCP client.

How to install

Prerequisites and setup steps ensure you can run the UPS MCP Server locally and securely.

# Prerequisites
- Python 3.12 or higher
- Install uv (Python Package)

# Install the MCP server package via uv
uvx --from git+https://github.com/UPS-API/ups-mcp ups-mcp

# Optional: use an older version
uvx --from git+https://github.com/UPS-API/ups-mcp@v1.0.0 ups-mcp

Additional notes

Environment variables are used to configure your UPS MCP Server instance. Store these secrets securely and do not commit them to version control.

Note the required credentials: CLIENT_ID, CLIENT_SECRET, and ENVIRONMENT. Set ENVIRONMENT to test for the sandbox environment or production for live usage.

Example configuration snippet for running the MCP server locally via a client that launches it as a stdio process is shown below. This demonstrates the expected command, arguments, and environment variables.

{
  "mcpServers": {
    "ups_mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": ["--from", "git+https://github.com/UPS-API/ups-mcp", "ups-mcp"],
      "env": {
        "CLIENT_ID": "YOUR_CLIENT_ID",
        "CLIENT_SECRET": "YOUR_CLIENT_SECRET",
        "ENVIRONMENT": "test"
      }
    }
  }
}

Available tools

track_package

Track a package using the UPS Tracking API. Returns a JSON string with tracking data including status, milestones, and delivery information.

validate_address

Validate a U.S. or Puerto Rico address using the UPS Address Validation API. Returns the API's JSON response with validation results.