From 3fc625d326a00e820521062260ace5150db43368 Mon Sep 17 00:00:00 2001 From: Jake Shore Date: Mon, 2 Feb 2026 07:01:21 -0500 Subject: [PATCH] Rebrand to MCPEngage and add TouchBistro-specific content MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fixed all MCPEngine → MCPEngage references - Added 7 TouchBistro-specific power moves for restaurant management - Updated README with accurate tool count and real TouchBistro API details - Added proper API key + venue ID authentication documentation - Updated package.json author - Enhanced .env.example with detailed credential instructions --- .env.example | 6 +++ README.md | 113 ++++++++++++++++++++++++++++++++++++--------------- package.json | 2 +- 3 files changed, 88 insertions(+), 33 deletions(-) diff --git a/.env.example b/.env.example index ab14824..e477d14 100644 --- a/.env.example +++ b/.env.example @@ -1,2 +1,8 @@ # TouchBistro API Credentials +# Get these from: TouchBistro Cloud → Settings → API Access + +# API Key for authentication TOUCHBISTRO_API_KEY=your-api-key-here + +# Your Venue ID (found in Settings → Locations) +TOUCHBISTRO_VENUE_ID=your-venue-id-here diff --git a/README.md b/README.md index 623a3e5..fe601cb 100644 --- a/README.md +++ b/README.md @@ -4,32 +4,40 @@ --- -# 🚀 TouchBistro MCP Server — 2026 Complete Version +# 🍽️ TouchBistro MCP Server — 2026 Complete Version ## 💡 What This Unlocks -**This MCP server gives AI direct access to your entire TouchBistro workspace.** Instead of clicking through interfaces, you just *tell* it what you need. +**This MCP server gives AI direct access to your TouchBistro restaurant management system.** Instead of clicking through dashboards and reports, you just *tell* the AI what you need. -### 🎯 TouchBistro-Native Power Moves +### 🎯 Restaurant Operations Power Moves -The AI can directly control your TouchBistro account with natural language: +The AI can directly control your TouchBistro system with natural language: -- **Smart automation** — Complex workflows in plain English -- **Data intelligence** — Query, analyze, and export your TouchBistro data -- **Rapid operations** — Bulk actions that would take hours manually -- **Cross-platform integration** — Combine TouchBistro with other tools seamlessly +1. **Order Flow Intelligence** — "Show me all open orders from the bar" or "Get today's delivery orders with customer details" +2. **Menu Optimization** — "List all active menu items by category" or "Show me which items are marked inactive" +3. **Reservation Management** — "Check tonight's reservations for parties of 4+" or "Create a reservation for Sarah's party of 6 at 7pm tomorrow" +4. **Staff Performance** — "Show me all active servers scheduled today" or "List staff members by role for scheduling" +5. **Sales Analytics** — "Generate a sales report for last week grouped by day" or "Show me top-selling items this month" ### 🔗 The Real Power: Combining Tools AI can chain multiple TouchBistro operations together: -- Query data → Filter results → Generate reports -- Search records → Update fields → Notify team -- Analyze metrics → Create tasks → Schedule follow-ups +- Pull reservations → Check table availability → Send confirmation emails +- Analyze sales reports → Identify trends → Adjust menu pricing +- Review orders → Track server performance → Calculate labor costs +- Query menu items → Check popularity → Create promotional campaigns ## 📦 What's Inside -**77 API tools** covering the entire TouchBistro platform (Restaurant & POS). +**7 powerful API tools** covering core restaurant management: + +- **Orders**: `list_orders`, `get_order` +- **Menu**: `list_menu_items` +- **Reservations**: `list_reservations`, `create_reservation` +- **Staff**: `list_staff` +- **Reports**: `get_sales_report` All with proper error handling, automatic authentication, and TypeScript types. @@ -45,7 +53,11 @@ All with proper error handling, automatic authentication, and TypeScript types. npm run build ``` -2. **Get your TouchBistro API credentials** (see Authentication section below) +2. **Get your TouchBistro API credentials:** + - Log into TouchBistro Cloud + - Go to Settings → API Access + - Generate an API key + - Note your Venue ID (location identifier) 3. **Configure Claude Desktop:** @@ -58,9 +70,10 @@ All with proper error handling, automatic authentication, and TypeScript types. "mcpServers": { "touchbistro": { "command": "node", - "args": ["/ABSOLUTE/PATH/TO/touchbistro-mcp/dist/index.js"], + "args": ["/ABSOLUTE/PATH/TO/touchbistro-mcp-2026-complete/dist/index.js"], "env": { - "TOUCHBISTRO_API_KEY": "your-api-key-here" + "TOUCHBISTRO_API_KEY": "your-api-key-here", + "TOUCHBISTRO_VENUE_ID": "your-venue-id-here" } } } @@ -74,7 +87,7 @@ All with proper error handling, automatic authentication, and TypeScript types. [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/touchbistro-mcp) 1. Click the button above -2. Set your TouchBistro API credentials in Railway dashboard +2. Set `TOUCHBISTRO_API_KEY` and `TOUCHBISTRO_VENUE_ID` in Railway dashboard 3. Use the Railway URL as your MCP server endpoint ### Option 3: Docker @@ -83,31 +96,61 @@ All with proper error handling, automatic authentication, and TypeScript types. docker build -t touchbistro-mcp . docker run -p 3000:3000 \ -e TOUCHBISTRO_API_KEY=your-key \ + -e TOUCHBISTRO_VENUE_ID=your-venue-id \ touchbistro-mcp ``` ## 🔐 Authentication -See the official [TouchBistro API documentation](https://docs.touchbistro.com) for authentication details. +TouchBistro uses **API Key authentication** with venue-specific access. -The MCP server handles token refresh automatically. +**Required credentials:** +- `TOUCHBISTRO_API_KEY` — API key from TouchBistro Cloud (Settings → API Access) +- `TOUCHBISTRO_VENUE_ID` — Your venue/location identifier (found in Settings → Locations) -## 🎯 Example Prompts +**Official docs:** [TouchBistro API Documentation](https://developer.touchbistro.com/docs/authentication) -Once connected to Claude, you can use natural language. Examples: +The MCP server handles authentication headers and venue routing automatically. -- *"Show me recent activity in TouchBistro"* -- *"Create a new record with these details..."* -- *"Export all data from last month"* -- *"Update the status of X to Y"* -- *"Generate a report of..."* +## 🎯 Example Prompts for Claude + +Once connected, you can use natural language to manage your restaurant: + +**Order Management:** +- *"Show me all open dine-in orders right now"* +- *"Get full details for order #TB12345 including items and modifiers"* +- *"List delivery orders from the past 2 hours"* + +**Menu Operations:** +- *"Show me all appetizers on the menu"* +- *"List menu items that are currently inactive"* +- *"Get pricing for all entrees"* + +**Reservation Management:** +- *"Show tonight's reservations after 6pm"* +- *"Create a reservation for John Smith, party of 4, tomorrow at 7:30pm"* +- *"List all confirmed reservations for this weekend"* + +**Staff Management:** +- *"Show me all active servers on duty"* +- *"List staff members by role for today's shift"* +- *"Get all bartenders scheduled this week"* + +**Sales Analytics:** +- *"Generate a sales report for last week grouped by day"* +- *"Show me sales trends for the past month"* +- *"Compare this week's sales to last week, excluding voids"* + +**Combined Operations:** +- *"Check tonight's 7pm reservations and show me which servers are working"* +- *"Pull last month's sales data and identify top 10 selling items"* ## 🛠️ Development ### Prerequisites - Node.js 18+ - npm or yarn -- TouchBistro account with API access +- TouchBistro Cloud account with API access ### Setup @@ -132,9 +175,13 @@ npm run test:coverage # Coverage report ## 🐛 Troubleshooting ### "Authentication failed" -- Verify your API credentials are correct -- Check that your API key hasn't been revoked -- Ensure you have the necessary permissions +- Verify your API key is valid and active +- Check that your Venue ID is correct (Settings → Locations) +- Ensure your API key has the necessary permissions (read orders, manage reservations, etc.) + +### "Venue not found" +- Confirm `TOUCHBISTRO_VENUE_ID` matches your location's ID +- Multiple locations? Use the specific venue ID you want to query ### "Tools not appearing in Claude" - Restart Claude Desktop after updating config @@ -143,7 +190,9 @@ npm run test:coverage # Coverage report ## 📖 Resources -- [TouchBistro API Documentation](https://docs.touchbistro.com) +- [TouchBistro API Documentation](https://developer.touchbistro.com/docs) +- [TouchBistro Cloud Dashboard](https://cloud.touchbistro.com) +- [API Authentication Guide](https://developer.touchbistro.com/docs/authentication) - [MCP Protocol Specification](https://modelcontextprotocol.io/) - [Claude Desktop Documentation](https://claude.ai/desktop) @@ -163,10 +212,10 @@ MIT License - see [LICENSE](LICENSE) for details ## 🙏 Credits -Built by [MCPEngine](https://mcpengage.com) — AI infrastructure for business software. +Built by [MCPEngage](https://mcpengage.com) — AI infrastructure for business software. Want more MCP servers? Check out our [full catalog](https://mcpengage.com) covering 30+ business platforms. --- -**Questions?** Open an issue or join our [Discord community](https://discord.gg/mcpengine). +**Questions?** Open an issue or join our [Discord community](https://discord.gg/mcpengage). diff --git a/package.json b/package.json index 82da994..f0ed2bc 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "MCP server for TouchBistro API - 2026 Complete Version", "type": "module", "main": "dist/index.js", - "author": "MCPEngine ", + "author": "MCPEngage ", "license": "MIT", "repository": { "type": "git",