ShipBob API MCP Server

ShipBob API MCP サーバー

ShipBob の e コマースフルフィルメント API と連携する、包括的な Model Context Protocol（MCP）サーバーです。

## 機能

この MCP サーバーでは、ShipBob API の主要な機能すべてに対応するツールとリソースを利用できます。

- **商品**：商品カタログを管理します
- **注文**：注文を作成、管理します
- **在庫**：在庫数を追跡、調整します
- **フルフィルメント**：出荷とフルフィルメントのプロセスを管理します
- **Webhook**：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`：新しい出荷を作成します

### Webhook
- `list_webhooks`：設定済みのすべての Webhook を一覧表示します
- `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