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许可证。