article
README
🚀 ShipBob API MCP 服务器
ShipBob API MCP 服务器提供了一系列与 ShipBob 电子商务履行 API 交互的工具,能帮助您高效管理产品、订单、库存等业务流程,提升电子商务运营效率。
🚀 快速开始
先决条件
- Node.js 16 或更高版本
- ShipBob API 密钥(从您的 ShipBob 控制台获得)
安装
- 克隆此仓库。
- 安装依赖项:
npm install
- 创建包含您的 ShipBob API 密钥的
.env文件:
SHIPBOB_API_KEY=your_api_key_here
运行服务器
启动服务器:
npm run dev
使用 MCP 检查器进行测试
使用 MCP 检查器测试服务器:
npm run inspect
这将打开一个 Web 界面,您可以在其中:
- 浏览可用工具和资源。
- 使用自定义输入测试工具。
- 查看服务器日志和响应。
✨ 主要特性
此 MCP 服务器提供了与 ShipBob 电子商务履行 API 交互的所有主要功能工具:
- 产品:管理您的产品目录。
- 订单:创建和管理订单。
- 库存:跟踪和调整库存水平。
- 履行:管理装运和履行流程。
- 网络钩子:配置 ShipBob 事件的通知。
- 退货:处理和管理退货请求。
- 位置:获取履行中心的信息。
- 渠道:管理销售通道。
- 报告:生成并检索报告。
💻 使用示例
可用工具
产品管理
list_products:列出 ShipBob 存货中的产品。get_product:获取特定产品的详细信息。create_product:创建新商品。update_product:更新现有商品。
订单管理
list_orders:列出您 ShipBob 账户中的订单。get_order:获取特定订单的详细信息。create_order:创建新订单。cancel_order:取消现有订单。
库存管理
get_inventory:获取所有履行中心的库存信息。get_product_inventory:获取特定产品的库存信息。get_inventory_levels:获取所有产品的当前库存水平。adjust_inventory:进行库存调整。
履行
list_shipments:列出您账户中的所有装运。get_shipment:获取特定装运的详细信息。create_shipment:创建新的装运。
网络钩子
list_webhooks:列出所有配置的网络钩子。create_webhook:创建新的网络钩子。delete_webhook:删除现有的网络钩子。
退货
list_returns:列出您账户中的所有退货。get_return:获取特定退货的详细信息。create_return:创建新的退货。
位置
list_fulfillment_centers:列出所有履行中心。get_fulfillment_center:获取特定履行中心的详细信息。
渠道
list_channels:列出所有销售通道。get_channel:获取特定销售通道的详细信息。
报告
get_inventory_report:获取库存报告。get_orders_report:获取订单报告。get_shipping_report:获取运输报告。
可用资源
shipbob://docs/{section}:访问 ShipBob API 的文档。- 可用部分:概述、身份验证、产品、订单、库存、履行、网络钩子、退货、位置、通道、报告。
📄 许可证
MIT
微信扫一扫