Сервер Model Context Protocol (MCP) для доставки и логистики UPS. Этот сервер позволяет системам ИИ легко интегрироваться с инструментами UPS API.

Пользователи могут интегрироваться с MCP-сервером, чтобы позволить агентам ИИ облегчать отслеживание событий от их имени, включая отслеживание состояния груза, последнего транзитного экрана и ожидаемой даты и времени доставки. Агенты будут аутентифицированы с использованием учетных данных клиентов OAuth, предоставленных пользователем после создания приложения на Портале разработчиков UPS.

Использование

** Предпосылки** Получите идентификатор клиента и секрет клиента: создайте приложение на Портале разработчиков UPS для получения ваших учетных данных OAuth - идентификатор клиента и секрет клиента. Python 3.12 или выше Установить uv (Python Package)

** Переменные окружающей среды**

UPS Client ID

Секрет клиента UPS

• указывать на Тест (CIE) или Производство (Принятые значения: Тест, производство)

**Примечание: Ваши учетные данные API чувствительны. Не привязывайте их к контролю версий. Мы рекомендуем безопасно управлять секретами с помощью GitHub Secrets, хранилища или менеджера паролей.

** Исполнение**

Вы можете запустить пакет с помощью uvx:

UPS MCP Server

A Model Context Protocol (MCP) server for UPS shipping and logistics capabilities. This server enables AI systems to seamlessly integrate with UPS API tools.

Users can integrate with the MCP server to allow AI agents to facilitate tracking events on their behalf, including tracking the status of a shipment, the latest transit screen, and expected delivery date and time. Agents will be authenticated using OAuth client credentials provided by the user after application creation on the UPS Developer Portal.

Usage

Prerequisites

• Obtain a Client ID and Client Secret: Create an application on the UPS Developer Portal to obtain your OAuth credentials – Client ID and Client Secret. (https://developer.ups.com/get-started?loc=en_US)
• Python 3.12 or higher
• Install uv (Python Package)

Environment Variables

• CLIENT_ID - UPS Client ID
• CLIENT_SECRET - UPS Client Secret
• ENVIRONMENT - Whether to point to Test (CIE) or Production (Accepted values: test, production)

Note: Your API credentials are sensitive. Do not commit them to version control. We recommend managing secrets securely using GitHub Secrets, a vault, or a password manager.

Execution

You can run the package using uvx:

uvx --from git+https://github.com/UPS-API/ups-mcp ups-mcp

To use an older version, you can specify the version number like so:

uvx --from git+https://github.com/UPS-API/[email protected] ups-mcp

Popular Integrations

Here are sample config files for popular integrations. Different MCP Clients may require modification.

Claude Desktop

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

GitHub Copilot in VS Code

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

Available Tools

• track_package: Track a package using the UPS Tracking API

  Args:

  • inquiryNumber (str): the unique package identifier. Each inquiry number must be between 7 and 34 characters in length. Required.
  • locale (str): Language and country code of the user, separated by an underscore. Default value is ‘en_US’. Not required.
  • returnSignature (bool): a boolean to indicate whether a signature is required, default is false. Not required.
  • returnMilestones (bool): a boolean to indicate whether detailed information on a package’s movements is required, default is false. Not required