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

✨ 主要特性

• 提供全面的 API 接口，覆蓋餐廳運營的多個關鍵方面。
• 支持菜單管理、訂單創建與處理、庫存更新以及員工信息管理。
• 具備完善的錯誤處理機制，方便調試和問題排查。
• 提供測試腳本，可驗證服務器功能是否正常。

📦 安裝指南

安裝依賴

確保你已經安裝了 Node.js 和 npm。然後運行以下命令安裝所需的依賴：

npm install express axios cors dotenv

配置環境變量

創建一個 .env 文件，並添加你的 Tandoor API 令牌：

TANDOOR_API_TOKEN=your-api-token

💻 使用示例

基礎用法

獲取菜單

獲取餐廳的當前菜單。

{
  "menuItems": [
    {
      "id": 1,
      "name": "Margherita Pizza",
      "price": 12.99,
      "description": "Classic Italian pizza with tomatoes, mozzarella and basil.",
      "category": "Pizza"
    },
    // 更多菜品...
  ]
}

創建新訂單

創建一個新的餐廳訂單。

{
  "orderItems": [
    {
      "foodId": number,
      "quantity": number,
      "price": number
    },
    // 更多菜品...
  ],
  "customerId": number,
  "totalAmount": number,
  "paymentMethod": string
}

更新庫存

更新餐廳的庫存信息。

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

高級用法

獲取員工列表

獲取餐廳的所有員工信息。

{
  "employeeList": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "role": "Chef"
    },
    // 更多員工...
  ]
}

更新員工信息

更新指定員工的信息。

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

📚 詳細文檔

基礎接口

獲取菜單

• 請求方法：GET
• 請求路徑：/api/menu
• 查詢參數：無
• 返回格式：JSON

創建新訂單

• 請求方法：POST
• 請求路徑：/api/order
• 請求參數：見基礎用法示例
• 返回格式：JSON

更新庫存

• 請求方法：PUT
• 請求路徑：/api/inventory
• 請求參數：見基礎用法示例
• 返回格式：JSON

高級功能

獲取員工列表

• 請求方法：GET
• 請求路徑：/api/employees
• 查詢參數：無
• 返回格式：JSON

更新員工信息

• 請求方法：PUT
• 請求路徑：/api/employees/:id
• 請求參數：見高級用法示例
• 返回格式：JSON

錯誤處理

錯誤碼

• 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 餐廳管理系統的各項功能。