# Booqable MCP Server

A Model Context Protocol (MCP) server for integrating with Booqable. This server allows AI assistants to interact directly with your Booqable rental management system, providing tools to manage inventory, orders, and more.

Built with TypeScript and leveraging the official Booqable API.

---

## Available Modules & Tools

### Inventory
Manage product groups and inventory items.
* `inventory_list`: List product groups (inventory items). Optionally filter by name, SKU, type, or tracking mode. Includes photo URLs by default.
* `inventory_get`: Fetch a single product group by UUID. Returns full details including photo URL by default.
* `inventory_search`: Full-text search across product group names and SKUs. Returns matching items with photo URLs.

### Orders
Manage rental orders and their contents.
* `orders_list`: List orders with optional filters. Supports full-text search by customer name or order number.
* `orders_get`: Fetch a single order by UUID, optionally including customer and line items.
* `orders_create`: Create a new order with start/end dates and optional customer/location.
* `orders_update`: Update an existing order's attributes by UUID.
* `orders_get_items`: Get all items (charge lines) of an order with product details (title, quantity, price, SKU, photo URL) in a single API call.

### System
* `ping`: Health check — returns a simple pong to verify connectivity.

---

## Setup & Installation

1. Clone the repository:
   ```bash
   git clone https://github.com/Themetralla3000/booqable-mcp-server.git
   cd booqable-mcp-server
   ```
2. Install dependencies:
   ```bash
   npm install
   ```
3. Configure your API keys in the environment file (`.env`):
   ```bash
   cp .env.example .env
   ```
4. Build the project:
   ```bash
   npm run build
   ```

## Configuration

Edit the `.env` file with your Booqable instance details. You can generate an API key from your Booqable settings dashboard:

```env
BOOQABLE_COMPANY_SLUG=your-company-slug
BOOQABLE_API_KEY=your_api_key_here
```

## Usage with Claude Desktop / Cursor

To use this MCP with Claude Desktop or Cursor, add the following configuration to your MCP config file (e.g., `claude_desktop_config.json`):

```json
{
  "mcpServers": {
    "booqable": {
      "command": "node",
      "args": ["/absolute/path/to/booqable-mcp-server/dist/index.js"],
      "env": {
        "BOOQABLE_COMPANY_SLUG": "your-company-slug",
        "BOOQABLE_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

## License

MIT License