Shipstation MCP Server

🚀 船站API MCP服務器

這是一個全面的模型上下文協議（MCP）服務器，用於與船站API進行交互。該服務器提供了管理訂單、運輸、承運人、倉庫、產品、客戶、商店、網絡鉤和履行所需的所有工具和資源。

🚀 快速開始

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

   npm install
   

3. 創建包含船站API憑證的.env文件：

   SHIPSTATION_API_KEY=your_api_key
   SHIPSTATION_API_SECRET=your_api_secret
   

4. 運行服務器：

   npm run dev
   

5. 使用MCP檢測工具測試：

   npm run inspect
   

✨ 主要特性

• 全面覆蓋船站API的所有端點。
• 為所有API操作提供結構化工具。
• 提供API參考文檔資源。
• 具備錯誤處理和日誌記錄功能。

💻 使用示例

基礎用法

以下是使用list_orders工具列出訂單的示例：

// 假設這裡有調用 list_orders 的代碼邏輯
// 代碼保持原始邏輯，這裡僅作示例示意
const listOrders = () => {
  // 調用 list_orders 的具體實現
  console.log('Listing orders...');
}
listOrders();

高級用法

在某些複雜場景下，可能需要組合多個工具來完成特定任務。例如，先創建一個訂單，然後標記該訂單已發貨：

// 假設這裡有調用 create_order 和 mark_order_as_shipped 的代碼邏輯
// 代碼保持原始邏輯，這裡僅作示例示意
const createOrder = () => {
  console.log('Creating an order...');
}
const markOrderAsShipped = () => {
  console.log('Marking the order as shipped...');
}
createOrder();
markOrderAsShipped();

📚 詳細文檔

通過shipstation://docs/{section}資源訪問API文檔。可用部分如下：

• overview
• orders
• shipments
• carriers
• warehouses
• products
• customers
• stores
• webhooks
• fulfillments

示例：shipstation://docs/orders

🔧 技術細節

本服務器提供了豐富的工具，可用於管理與船站API交互的各個方面，以下是各工具的詳細說明：

訂單

• list_orders：列出所有訂單。
• get_order：獲取單個訂單的詳細信息。
• create_order：創建新訂單。
• mark_order_as_shipped：將訂單標記為已發貨。
• delete_order：刪除訂單。
• add_tag_to_order：為訂單添加標籤。
• remove_tag_from_order：從訂單中移除標籤。
• restore_order_from_hold：從暫停狀態恢復訂單。
• hold_order_until：將訂單暫停至指定時間。

運輸

• list_shipments：列出所有運輸信息。
• get_shipment：獲取單個運輸的詳細信息。
• create_label：創建運輸標籤。
• void_label：使運輸標籤失效。

承運人

• list_carriers：列出所有承運人。
• list_carrier_packages：列出承運人提供的包裹類型。
• list_carrier_services：列出承運人提供的服務。

倉庫

• list_warehouses：列出所有倉庫。
• get_warehouse：獲取單個倉庫的詳細信息。
• create_warehouse：創建新倉庫。
• update_warehouse：更新倉庫信息。
• delete_warehouse：刪除倉庫。

產品

• list_products：列出所有產品。
• get_product：獲取單個產品的詳細信息。
• create_product：創建新產品。
• update_product：更新產品信息。
• delete_product：刪除產品。

客戶

• list_customers：列出所有客戶。
• get_customer：獲取單個客戶的詳細信息。

商店

• list_stores：列出所有商店。
• get_store：獲取單個商店的詳細信息。
• list_marketplaces：列出商店所在的市場。
• refresh_store：刷新商店信息。
• deactivate_store：停用商店。
• reactivate_store：重新激活商店。

網絡鉤

• list_webhooks：列出所有網絡鉤。
• subscribe_to_webhook：訂閱網絡鉤。
• unsubscribe_from_webhook：取消訂閱網絡鉤。

履行單

• list_fulfillments：列出所有履行單。
• create_fulfillment_order：創建履行單。

📄 許可證

本項目採用MIT許可證。