shipboss MCP server

ShipBoss MCP服务器

通过人工智能对话提供运输和物流功能的MCP服务器。连接到FedEx、UPS和DHL以获取费率、创建标签、跟踪包裹和管理货运。

🔑 重要：您需要一个ShipBoss API令牌才能使用此服务器。从你的 ShipBoss管理员→ API集成. 📁 此设置使用本地开发模式 具有虚拟环境路径，以实现最大的兼容性和控制。

🚀 快速设置（5分钟）

先决条件

• Python 3.9+ 安装
• ShipBoss帐户 使用API令牌（在 ship.shipboss.io)

分步安装

步骤1：获取您的ShipBoss API代币 🔑 这是服务器与ShipBoss API通信所必需的。

1. 首选 ShipBoss 并登录
2. 导航到“管理”部分→ API集成
3. 生成新的API令牌并复制它
4. 确保此令牌安全 -下一步你需要它

步骤2：创建虚拟环境 🐍 使用虚拟环境是 必需的 以避免与您的系统Python安装发生依赖冲突。

# Create a virtual environment
python -m venv shipboss_env

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

# Install the package
pip install shipboss-mcp-server

⚠️ 重要：使用虚拟环境是 必需的 以避免与您的系统Python安装发生依赖冲突。

步骤3：配置API令牌 🔑 服务器需要您的API令牌才能向ShipBoss进行身份验证。选择以下方法之一：

选项A:.env文件（最简单-自动）📁

# Create environment file in the project directory
echo "SHIPBOSS_API_TOKEN=your_api_token_here" > .env

# Or use the provided template
cp example.env .env  # Then edit .env with your actual token

然后在MCP客户端中使用此配置：

{
  "mcpServers": {
    "shipboss-mcp": {
      "command": "C:\\path\\to\\shipboss_env\\Scripts\\python.exe",
      "args": ["C:\\path\\to\\shipboss-mcp\\shipboss_mcp_server.py"]
    }
  }
}

选项B：命令行参数

直接在MCP配置中添加您的令牌：

{
  "mcpServers": {
    "shipboss-mcp": {
      "command": "C:\\path\\to\\shipboss_env\\Scripts\\python.exe",
      "args": [
        "C:\\path\\to\\shipboss-mcp\\shipboss_mcp_server.py",
        "--api-token", "your_api_token_here"
      ]
    }
  }
}

选项C：环境变量

{
  "mcpServers": {
    "shipboss-mcp": {
      "command": "C:\\path\\to\\shipboss_env\\Scripts\\python.exe",
      "args": ["C:\\path\\to\\shipboss-mcp\\shipboss_mcp_server.py"],
      "env": {
        "SHIPBOSS_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

备注：替换 C:\path\to\shipboss_env 使用您的实际虚拟环境路径和 C:\path\to\shipboss-mcp 使用您的实际项目目录路径。

如何找到自己的路

对于Windows：

# Find your virtual environment Python executable
cd shipboss_env\Scripts
echo %CD%\python.exe

# Find your project directory
cd ..\..
echo %CD%\shipboss_mcp_server.py

对于macOS/Linux：

# Find your virtual environment Python executable
which python  # Should show the venv python path

# Find your project directory
pwd  # Current directory containing shipboss_mcp_server.py

快速验证：

# Test that your paths work
"C:\path\to\shipboss_env\Scripts\python.exe" "C:\path\to\shipboss-mcp\shipboss_mcp_server.py" --api-token your_token_here

步骤4：测试您的设置 🧪 确保您的虚拟环境已激活，然后重新启动MCP客户端并尝试以下命令：

• *“获取2磅包裹从纽约到洛杉矶的运费”*
• *创建从纽约州纽约市主街123号到加利福尼亚州洛杉矶橡树大道456号的联邦快递地面标签*

可用工具

• 拼 -健康检查
• get_parcel_rates -获取包裹运费
• create_parcel_label -使用直接下载URL创建包裹运输标签
• track_parcel -跟踪包裹发货
• create_pickup -安排承运商提货
• cancel_pickup -取消预定的取货
• get_feight_rates -获取货运报价
• 轨道重量 -跟踪货运

故障排除

常见问题：

1. “未找到python命令”或“未找到python.exe” ❌: 在运行服务器之前，请确保您的虚拟环境已激活。

- 解决方案：首先激活您的虚拟环境：

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

1. “需要API令牌”错误 🔐: 请确保已使用以下方法之一配置API令牌：

- 小心：创建一个 .env 提交 SHIPBOSS_API_TOKEN=your_token （自动加载） - 添加 --api-token your_token 到MCP配置中的args - 集 SHIPBOSS_API_TOKEN 在MCP配置的env部分 - 验证您的令牌确保它来自 ShipBoss API集成

1. “找不到.env文件”：The .env 文件应位于项目目录中 shipboss_mcp_server.py 位于（或如上所述将api密钥添加到json配置中。）

- 检查文件是否存在： ls -la .env - 验证令牌格式： cat .env （应显示 SHIPBOSS_API_TOKEN=your_token_here)

1. 未找到命令：确保软件包已安装 shipboss-mcp-server 命令在PATH中可用。

1. MCP配置中的路径问题：确保MCP配置中的路径正确：

- 使用虚拟环境Python可执行文件的完整路径 - 使用完整路径 shipboss_mcp_server.py 文件 - 确保路径使用正确的分隔符(\ 对于Windows， / 适用于macOS/Linux）