Tandoor MCP Server

🚀 Tandoor レストラン管理システム API ドキュメント

Tandoor レストラン管理システムは、レストランの日常運営を管理するための包括的な API インターフェースを提供します。これには、メニュー、注文、在庫、従業員などのさまざまな側面が含まれます。このドキュメントでは、各 API インターフェースの機能、パラメータ、および使用方法について詳しく説明します。

🚀 クイックスタート

📦 インストール

依存関係のインストール

Node.js と npm がインストールされていることを確認してください。次に、以下のコマンドを実行して必要な依存関係をインストールします。

npm install express axios cors dotenv

環境変数の設定

.env ファイルを作成し、Tandoor API トークンを追加します。

TANDOOR_API_TOKEN=your-api-token

💻 使用例

基本的な使用法

メニューの取得

レストランの現在のメニューを取得します。

• リクエストメソッド: GET
• リクエストパス: /api/menu
• クエリパラメータ: なし
• 返却形式: JSON

サンプルレスポンス

{
  "menuItems": [
    {
      "id": 1,
      "name": "Margherita Pizza",
      "price": 12.99,
      "description": "Classic Italian pizza with tomatoes, mozzarella and basil.",
      "category": "Pizza"
    },
    // 他の料理...
  ]
}

新しい注文の作成

新しいレストラン注文を作成します。

• リクエストメソッド: POST
• リクエストパス: /api/order
• リクエストパラメータ

{
  "orderItems": [
    {
      "foodId": number,
      "quantity": number,
      "price": number
    },
    // 他の料理...
  ],
  "customerId": number,
  "totalAmount": number,
  "paymentMethod": string
}

• 返却形式: JSON

サンプルレスポンス

{
  "orderId": 123,
  "orderStatus": "pending",
  "createdAt": "2023-10-01T15:30:00Z"
}

在庫の更新

レストランの在庫情報を更新します。

• リクエストメソッド: PUT
• リクエストパス: /api/inventory
• リクエストパラメータ

{
  "foodId": number,
  "newQuantity": number
}

• 返却形式: JSON

サンプルレスポンス

{
  "message": "Inventory updated successfully",
  "updatedFood": {
    "id": 5,
    "name": "Tomatoes",
    "quantity": 150
  }
}

高度な使用法

従業員リストの取得

レストランのすべての従業員情報を取得します。

• リクエストメソッド: GET
• リクエストパス: /api/employees
• クエリパラメータ: なし
• 返却形式: JSON

サンプルレスポンス

{
  "employeeList": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "role": "Chef"
    },
    // 他の従業員...
  ]
}

従業員情報の更新

指定された従業員の情報を更新します。

• リクエストメソッド: PUT
• リクエストパス: /api/employees/:id
• リクエストパラメータ

{
  "firstName": string,
  "lastName": string,
  "role": string
}

• 返却形式: JSON

サンプルレスポンス

{
  "message": "Employee updated successfully",
  "employee": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "role": "Head Chef"
  }
}

📚 ドキュメント

エラー処理

エラーコード

• 400 Bad Request: リクエストパラメータが誤っているか、不足しています。
• 401 Unauthorized: 未承認のアクセスです。
• 404 Not Found: リソースが存在しません。
• 500 Internal Server Error: サーバー内部エラーです。

サンプルエラーレスポンス

{
  "error": {
    "code": 400,
    "message": "Missing required parameter 'customerId'"
  }
}

テスト

サーバー機能が正常に動作していることを検証するためのテストスクリプトを提供しています。

npm run test

テストスクリプトには以下の機能があります。

1. 利用可能なすべての API インターフェースを一覧表示します。
2. 新しい注文の作成をテストします。
3. 在庫の更新をテストします。

トラブルシューティング

使用中に問題が発生した場合は、以下の手順で問題を解決してください。

1. サーバーが正しく起動し、[Setup] Tandoor Management System server running on stdio. が表示されていることを確認します。
2. Tandoor API トークンが正しく設定されていることを確認します。
3. ターミナルのエラーメッセージを確認し、より詳細なデバッグ情報を取得します。
4. テストスクリプトを使用してサーバー機能を検証し、MCP システムの問題を排除します。

以上のドキュメントを参照することで、Tandoor レストラン管理システムのさまざまな機能を全面的に理解して使用することができます。