article
README
🚀 TrackMage MCP服务器 - 货运跟踪API与物流API集成
TrackMage MCP服务器借助TrackMage API,实现了货运跟踪API、包裹监控和物流管理功能。它支持全球1600多家承运商的包裹跟踪。
✨ 主要特性
- 承运商支持:可跟踪全球1600多家承运商的包裹(完整列表)
- 资源管理:支持工作区、货运、订单、承运商和跟踪状态等资源的管理
- 实用工具:可创建货运/订单、获取货运检查点信息以及进行承运商检测
- 身份验证:支持使用客户端凭证进行OAuth认证
⚠️ 数据隐私声明
⚠️ 重要提示
与您的大语言模型(LLM)提供商共享数据:此MCP服务器会将数据提供给您使用的任何大语言模型(如Claude、ChatGPT等)。虽然这是MCP服务器的预期行为,但请确保您愿意与所选的大语言模型提供商共享物流数据,包括跟踪号码、客户电子邮件、地址和货运详情。
最佳实践:
- 如果您有隐私顾虑,仅使用非敏感或测试数据。
- 查看您的大语言模型提供商的数据处理政策。
- 如果有可用选项,考虑退出训练数据计划。
- 确保符合您所在组织的数据政策。
📦 安装指南
前提条件
- Node.js v18+
- TrackMage账户
获取凭证
- 注册并登录 TrackMage。
- 进入 设置 > API密钥。
- 输入 应用名称(例如,“MCP”)和 应用URL(例如,
http://localhost:3000)。 - 点击 生成 并复制您的 客户端ID 和 客户端密钥。
- 从仪表盘URL中记录您的 工作区ID。
选项1:本地部署
git clone https://github.com/yourusername/trackmage-mcp-server.git
cd trackmage-mcp-server
npm install
cp .env.example .env
# 使用您的凭证编辑.env文件
npm start
配置
编辑 .env 文件:
TRACKMAGE_CLIENT_ID=your_client_id_here
TRACKMAGE_CLIENT_SECRET=your_client_secret_here
TRACKMAGE_WORKSPACE_ID=your_workspace_id_here
💻 使用示例
启动服务器
npm start
使用配置
{
"mcpServers": {
"trackmage": {
"transport": {
"type": "http",
"host": "localhost",
"port": 3000
}
}
}
}
或者使用文件进程:
{
"mcpServers": {
"trackmage": {
"command": "node",
"args": ["/path/to/trackmage-mcp-server/index.js"],
"env": {
"TRACKMAGE_CLIENT_ID": "your_client_id_here",
"TRACKMAGE_CLIENT_SECRET": "your_client_secret_here",
"TRACKMAGE_WORKSPACE_ID": "your_workspace_id_here"
}
}
}
}
MCP资源
trackmage:///workspaces/{id}trackmage:///shipments/{id}trackmage:///orders/{id}trackmage:///carriers/{id}trackmage:///tracking_statuses/{id}
MCP工具
货运管理
create_shipment:创建新货运- 参数:
{ trackingNumber, originCarrier?, email?, workspaceId? } - 返回:创建的货运对象
- 参数:
update_shipment:更新现有货运- 参数:
{ shipmentId, trackingNumber?, originCarrier?, email?, status? } - 返回:更新后的货运对象
- 参数:
list_shipments:列出工作区中的货运- 参数:
{ workspaceId?, page?, itemsPerPage? } - 返回:货运对象数组
- 参数:
get_shipment_checkpoints:获取货运的跟踪检查点信息- 参数:
{ shipmentId } - 返回:跟踪检查点事件数组
- 参数:
retrack_shipments:通过跟踪号码重新跟踪多个货运- 参数:
{ trackingNumbers: [{ number, originCarrier? }], workspaceId? } - 返回:重新跟踪结果
- 参数:
订单管理
create_order:创建新订单- 参数:
{ orderNumber, email?, workspaceId? } - 返回:创建的订单对象
- 参数:
update_order:更新现有订单- 参数:
{ orderId, orderNumber?, email?, status? } - 返回:更新后的订单对象
- 参数:
list_orders:列出工作区中的订单- 参数:
{ workspaceId?, page?, itemsPerPage? } - 返回:订单对象数组
- 参数:
承运商管理
list_carriers:列出可用的承运商- 参数:
{ page?, itemsPerPage? } - 返回:包含代码和名称的承运商对象数组
- 参数:
detect_carrier:检测跟踪号码可能对应的承运商- 参数:
{ trackingNumber } - 返回:可能匹配的承运商数组
- 参数:
测试
npm test
微信扫一扫