Shipbob MCP Server

🚀 ShipBob API MCP 服務器

本 MCP 服務器提供了一系列強大工具，可與 ShipBob 電子商務履行 API 進行交互，助力您高效管理產品、訂單、庫存等電商業務的關鍵環節，提升運營效率。

🚀 快速開始

先決條件

• 需要安裝 Node.js 16 或更高版本。
• 您需從 ShipBob 控制檯獲取 ShipBob API 密鑰。

安裝

1. 克隆此倉庫。
2. 安裝依賴項：

npm install

3. 創建包含您的 ShipBob API 密鑰的 .env 文件：

SHIPBOB_API_KEY=your_api_key_here

運行服務器

啟動服務器：

npm run dev

使用 MCP 檢查器進行測試

使用 MCP 檢查器測試服務器：

npm run inspect

這將打開一個 Web 界面，您可以在其中：

• 瀏覽可用工具和資源。
• 使用自定義輸入測試工具。
• 查看服務器日誌和響應。

✨ 主要特性

• 產品：可對您的產品目錄進行有效管理。
• 訂單：支持創建和管理訂單。
• 庫存：能夠跟蹤和調整庫存水平。
• 履行：可管理裝運和履行流程。
• 網絡鉤子：可配置 ShipBob 事件的通知。
• 退貨：能處理和管理退貨請求。
• 位置：可獲取履行中心的信息。
• 渠道：可管理銷售通道。
• 報告：支持生成並檢索報告。

📦 安裝指南

安裝步驟

1. 克隆此倉庫。
2. 安裝依賴項：

npm install

3. 創建包含您的 ShipBob API 密鑰的 .env 文件：

SHIPBOB_API_KEY=your_api_key_here

💻 使用示例

基礎用法

以下為使用 MCP 服務器的基礎操作示例：

# 克隆倉庫
git clone <repository_url>

# 安裝依賴
npm install

# 創建 .env 文件並添加 API 密鑰
echo "SHIPBOB_API_KEY=your_api_key_here" > .env

# 啟動服務器
npm run dev

# 使用 MCP 檢查器測試服務器
npm run inspect

高級用法

若您需要進行更復雜的操作，可使用以下命令：

# 例如，使用特定工具進行測試
# 這裡假設您要列出所有產品
npm run inspect -- --tool list_products

📚 詳細文檔

可用工具

產品管理

• 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 許可證。