ShipBob API MCP 服务器

一个全面的模型上下文协议 (MCP) 服务器，用于与 ShipBob 的电子商务履行 API 交互。

## 功能

此 MCP 服务器为所有主要的 ShipBob API 功能提供工具和资源：

- **产品**: 管理您的产品目录
- **订单**: 创建和管理订单
- **库存**: 跟踪和调整库存水平
- **履行**: 管理发货和履行流程
- **Webhooks**: 配置 ShipBob 事件的通知
- **退货**: 处理和管理退货请求
- **地点**: 访问有关履行中心的信息
- **渠道**: 管理销售渠道
- **报告**: 生成和检索报告

## 开始使用

### 前提条件

- Node.js 16 或更高版本
- ShipBob API 密钥（从您的 ShipBob 仪表板获取）

### 安装

1. 克隆此存储库
2. 安装依赖项：
   ```
   npm install
   ```
3. 创建一个包含您的 ShipBob API 密钥的 `.env` 文件：
   ```
   SHIPBOB_API_KEY=your_api_key_here
   ```

### 运行服务器

启动服务器：
```
npm run dev
```

### 使用 MCP Inspector 进行测试

使用 MCP Inspector 测试服务器：
```
npm run inspect
```

这将打开一个 Web 界面，您可以在其中：
- 浏览可用的工具和资源
- 使用自定义输入测试工具
- 查看服务器日志和响应

## 可用工具

### 产品管理
- `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`: 创建一个新的发货

### Webhooks
- `list_webhooks`: 列出所有已配置的 Webhooks
- `create_webhook`: 创建一个新的 Webhook
- `delete_webhook`: 删除现有的 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 的文档
  - 可用部分：overview, authentication, products, orders, inventory, fulfillment, webhooks, returns, locations, channels, reporting

## 许可证

MIT