Tandoor MCP Server

🚀 Tandoor Restaurant Management System API Documentation

Tandoor Restaurant Management System offers a comprehensive set of API interfaces for managing daily restaurant operations, including menu, orders, inventory, and staff. This document details the functions, parameters, and usage of each API interface.

🚀 Quick Start

📦 Installation

Ensure you have Node.js and npm installed. Then, run the following command to install the required dependencies:

npm install express axios cors dotenv

Configuration

Create a .env file and add your Tandoor API token:

TANDOOR_API_TOKEN=your-api-token

💻 Usage Examples

Basic Usage

Get Menu

Retrieve the current menu of the restaurant.

• Request Method: GET
• Request Path: /api/menu
• Query Parameters: None
• Response Format: JSON

Example Response:

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

Create New Order

Create a new restaurant order.

• Request Method: POST
• Request Path: /api/order
• Request Parameters:

{
  "orderItems": [
    {
      "foodId": number,
      "quantity": number,
      "price": number
    }
    // More dishes...
  ],
  "customerId": number,
  "totalAmount": number,
  "paymentMethod": string
}

• Response Format: JSON

Example Response:

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

Update Inventory

Update the restaurant's inventory information.

• Request Method: PUT
• Request Path: /api/inventory
• Request Parameters:

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

• Response Format: JSON

Example Response:

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

Advanced Usage

Get Employee List

Retrieve information about all employees in the restaurant.

• Request Method: GET
• Request Path: /api/employees
• Query Parameters: None
• Response Format: JSON

Example Response:

{
  "employeeList": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "role": "Chef"
    }
    // More employees...
  ]
}

Update Employee Information

Update the information of a specified employee.

• Request Method: PUT
• Request Path: /api/employees/:id
• Request Parameters:

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

• Response Format: JSON

Example Response:

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

🔧 Technical Details

Error Handling

Error Codes

• 400 Bad Request: Incorrect or missing request parameters.
• 401 Unauthorized: Unauthorized access.
• 404 Not Found: Resource not found.
• 500 Internal Server Error: Internal server error.

Example Error Response

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

Testing

We provide a test script to verify the normal operation of the server:

npm run test

The test script offers the following functions:

1. List all available API interfaces.
2. Test creating a new order.
3. Test updating inventory.

Troubleshooting

If you encounter issues during use, follow these steps to troubleshoot:

1. Ensure the server is correctly started and displays [Setup] Tandoor Management System server running on stdio..
2. Check if your Tandoor API token is correctly configured.
3. Review the error messages in the terminal for more debugging clues.
4. Use the test script to verify server functionality and rule out issues with the MCP system.

With this documentation, you can comprehensively understand and utilize the various features of the Tandoor Restaurant Management System.