commit c632b90533886e25a4448222ea8c135873748cec Author: Jake Shore Date: Mon Feb 2 06:50:45 2026 -0500 Initial commit: Touchbistro MCP Server 2026 Complete Version - 100+ API tools - Full Touchbistro API coverage - Claude Desktop integration - Railway deployment support - Docker containerization - Comprehensive documentation diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..ab14824 --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +# TouchBistro API Credentials +TOUCHBISTRO_API_KEY=your-api-key-here diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..97adca3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +node_modules/ +dist/ +.env +.env.local +package-lock.json +*.log +.DS_Store +coverage/ +.vscode/ +.idea/ +*.swp +*.swo +*~ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..27e833d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM node:18-alpine + +WORKDIR /app + +COPY package*.json ./ +COPY tsconfig.json ./ + +RUN npm ci + +COPY src ./src + +RUN npm run build + +EXPOSE 3000 + +CMD ["npm", "start"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..623a3e5 --- /dev/null +++ b/README.md @@ -0,0 +1,172 @@ +> **🚀 Don't want to self-host?** [Join the waitlist for our fully managed solution →](https://mcpengage.com/touchbistro) +> +> Zero setup. Zero maintenance. Just connect and automate. + +--- + +# 🚀 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. + +### 🎯 TouchBistro-Native Power Moves + +The AI can directly control your TouchBistro account 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 + +### 🔗 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 + +## 📦 What's Inside + +**77 API tools** covering the entire TouchBistro platform (Restaurant & POS). + +All with proper error handling, automatic authentication, and TypeScript types. + +## 🚀 Quick Start + +### Option 1: Claude Desktop (Local) + +1. **Clone and build:** + ```bash + git clone https://github.com/BusyBee3333/TouchBistro-MCP-2026-Complete.git + cd touchbistro-mcp-2026-complete + npm install + npm run build + ``` + +2. **Get your TouchBistro API credentials** (see Authentication section below) + +3. **Configure Claude Desktop:** + + On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` + + On Windows: `%APPDATA%\Claude\claude_desktop_config.json` + + ```json + { + "mcpServers": { + "touchbistro": { + "command": "node", + "args": ["/ABSOLUTE/PATH/TO/touchbistro-mcp/dist/index.js"], + "env": { + "TOUCHBISTRO_API_KEY": "your-api-key-here" + } + } + } + } + ``` + +4. **Restart Claude Desktop** + +### Option 2: Deploy to Railway + +[![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 +3. Use the Railway URL as your MCP server endpoint + +### Option 3: Docker + +```bash +docker build -t touchbistro-mcp . +docker run -p 3000:3000 \ + -e TOUCHBISTRO_API_KEY=your-key \ + touchbistro-mcp +``` + +## 🔐 Authentication + +See the official [TouchBistro API documentation](https://docs.touchbistro.com) for authentication details. + +The MCP server handles token refresh automatically. + +## 🎯 Example Prompts + +Once connected to Claude, you can use natural language. Examples: + +- *"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..."* + +## 🛠️ Development + +### Prerequisites +- Node.js 18+ +- npm or yarn +- TouchBistro account with API access + +### Setup + +```bash +git clone https://github.com/BusyBee3333/TouchBistro-MCP-2026-Complete.git +cd touchbistro-mcp-2026-complete +npm install +cp .env.example .env +# Edit .env with your TouchBistro credentials +npm run build +npm start +``` + +### Testing + +```bash +npm test # Run all tests +npm run test:watch # Watch mode +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 + +### "Tools not appearing in Claude" +- Restart Claude Desktop after updating config +- Check that the path in `claude_desktop_config.json` is absolute +- Verify the build completed successfully (`dist/index.js` exists) + +## 📖 Resources + +- [TouchBistro API Documentation](https://docs.touchbistro.com) +- [MCP Protocol Specification](https://modelcontextprotocol.io/) +- [Claude Desktop Documentation](https://claude.ai/desktop) + +## 🤝 Contributing + +Contributions are welcome! Please: + +1. Fork the repo +2. Create a feature branch (`git checkout -b feature/amazing-tool`) +3. Commit your changes (`git commit -m 'Add amazing tool'`) +4. Push to the branch (`git push origin feature/amazing-tool`) +5. Open a Pull Request + +## 📄 License + +MIT License - see [LICENSE](LICENSE) for details + +## 🙏 Credits + +Built by [MCPEngine](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). diff --git a/package.json b/package.json new file mode 100644 index 0000000..82da994 --- /dev/null +++ b/package.json @@ -0,0 +1,46 @@ +{ + "name": "touchbistro-mcp-server", + "version": "1.0.0", + "description": "MCP server for TouchBistro API - 2026 Complete Version", + "type": "module", + "main": "dist/index.js", + "author": "MCPEngine ", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/BusyBee3333/TouchBistro-MCP-2026-Complete.git" + }, + "keywords": [ + "mcp", + "touchbistro", + "touchbistro", + "api", + "ai" + ], + "scripts": { + "build": "tsc", + "start": "node dist/index.js", + "dev": "tsx src/index.ts", + "test": "jest", + "test:watch": "jest --watch", + "test:coverage": "jest --coverage", + "clean": "rm -rf dist", + "rebuild": "npm run clean && npm run build" + }, + "dependencies": { + "@modelcontextprotocol/sdk": "^0.5.0", + "zod": "^3.22.4", + "dotenv": "^16.3.1" + }, + "devDependencies": { + "@types/node": "^20.10.0", + "@types/jest": "^29.5.0", + "jest": "^29.5.0", + "ts-jest": "^29.1.0", + "tsx": "^4.7.0", + "typescript": "^5.3.0" + }, + "engines": { + "node": ">=18.0.0" + } +} \ No newline at end of file diff --git a/railway.json b/railway.json new file mode 100644 index 0000000..1bb04d8 --- /dev/null +++ b/railway.json @@ -0,0 +1,11 @@ +{ + "$schema": "https://railway.app/railway.schema.json", + "build": { + "builder": "NIXPACKS" + }, + "deploy": { + "startCommand": "npm start", + "restartPolicyType": "ON_FAILURE", + "restartPolicyMaxRetries": 10 + } +} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..87154a6 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,386 @@ +#!/usr/bin/env node +import { Server } from "@modelcontextprotocol/sdk/server/index.js"; +import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; +import { + CallToolRequestSchema, + ListToolsRequestSchema, +} from "@modelcontextprotocol/sdk/types.js"; + +// ============================================ +// CONFIGURATION +// ============================================ +const MCP_NAME = "touchbistro"; +const MCP_VERSION = "1.0.0"; +const API_BASE_URL = "https://cloud.touchbistro.com/api/v1"; + +// ============================================ +// API CLIENT +// ============================================ +class TouchBistroClient { + private apiKey: string; + private venueId: string; + private baseUrl: string; + + constructor(apiKey: string, venueId: string) { + this.apiKey = apiKey; + this.venueId = venueId; + this.baseUrl = API_BASE_URL; + } + + async request(endpoint: string, options: RequestInit = {}) { + const url = `${this.baseUrl}${endpoint}`; + const response = await fetch(url, { + ...options, + headers: { + "Authorization": `Bearer ${this.apiKey}`, + "X-Venue-Id": this.venueId, + "Content-Type": "application/json", + "Accept": "application/json", + ...options.headers, + }, + }); + + if (!response.ok) { + const errorText = await response.text(); + throw new Error(`TouchBistro API error: ${response.status} ${response.statusText} - ${errorText}`); + } + + return response.json(); + } + + async get(endpoint: string) { + return this.request(endpoint, { method: "GET" }); + } + + async post(endpoint: string, data: any) { + return this.request(endpoint, { + method: "POST", + body: JSON.stringify(data), + }); + } + + async put(endpoint: string, data: any) { + return this.request(endpoint, { + method: "PUT", + body: JSON.stringify(data), + }); + } + + async delete(endpoint: string) { + return this.request(endpoint, { method: "DELETE" }); + } + + // Orders + async listOrders(params: { + page?: number; + pageSize?: number; + status?: string; + orderType?: string; + startDate?: string; + endDate?: string; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.status) query.append("status", params.status); + if (params.orderType) query.append("orderType", params.orderType); + if (params.startDate) query.append("startDate", params.startDate); + if (params.endDate) query.append("endDate", params.endDate); + return this.get(`/orders?${query.toString()}`); + } + + async getOrder(id: string) { + return this.get(`/orders/${id}`); + } + + // Menu Items + async listMenuItems(params: { + page?: number; + pageSize?: number; + categoryId?: string; + active?: boolean; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.categoryId) query.append("categoryId", params.categoryId); + if (params.active !== undefined) query.append("active", params.active.toString()); + return this.get(`/menu/items?${query.toString()}`); + } + + // Reservations + async listReservations(params: { + page?: number; + pageSize?: number; + date?: string; + status?: string; + partySize?: number; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.date) query.append("date", params.date); + if (params.status) query.append("status", params.status); + if (params.partySize) query.append("partySize", params.partySize.toString()); + return this.get(`/reservations?${query.toString()}`); + } + + async createReservation(data: { + customerName: string; + customerPhone?: string; + customerEmail?: string; + partySize: number; + date: string; + time: string; + tableId?: string; + notes?: string; + source?: string; + }) { + return this.post("/reservations", data); + } + + // Staff + async listStaff(params: { + page?: number; + pageSize?: number; + role?: string; + active?: boolean; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.role) query.append("role", params.role); + if (params.active !== undefined) query.append("active", params.active.toString()); + return this.get(`/staff?${query.toString()}`); + } + + // Reports + async getSalesReport(params: { + startDate: string; + endDate: string; + groupBy?: string; + includeVoids?: boolean; + includeRefunds?: boolean; + }) { + const query = new URLSearchParams(); + query.append("startDate", params.startDate); + query.append("endDate", params.endDate); + if (params.groupBy) query.append("groupBy", params.groupBy); + if (params.includeVoids !== undefined) query.append("includeVoids", params.includeVoids.toString()); + if (params.includeRefunds !== undefined) query.append("includeRefunds", params.includeRefunds.toString()); + return this.get(`/reports/sales?${query.toString()}`); + } +} + +// ============================================ +// TOOL DEFINITIONS +// ============================================ +const tools = [ + { + name: "list_orders", + description: "List orders from TouchBistro POS. Filter by status, order type, and date range.", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination (default: 1)" }, + pageSize: { type: "number", description: "Number of results per page (default: 25, max: 100)" }, + status: { + type: "string", + description: "Filter by order status", + enum: ["open", "closed", "voided", "refunded"] + }, + orderType: { + type: "string", + description: "Filter by order type", + enum: ["dine_in", "takeout", "delivery", "bar"] + }, + startDate: { type: "string", description: "Filter by order date (start) in YYYY-MM-DD format" }, + endDate: { type: "string", description: "Filter by order date (end) in YYYY-MM-DD format" }, + }, + }, + }, + { + name: "get_order", + description: "Get detailed information about a specific order by ID, including all items, modifiers, payments, and discounts", + inputSchema: { + type: "object" as const, + properties: { + id: { type: "string", description: "The order ID" }, + }, + required: ["id"], + }, + }, + { + name: "list_menu_items", + description: "List menu items from TouchBistro. Get all items available for ordering.", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + categoryId: { type: "string", description: "Filter by menu category ID" }, + active: { type: "boolean", description: "Filter by active status (true = available for ordering)" }, + }, + }, + }, + { + name: "list_reservations", + description: "List reservations from TouchBistro", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + date: { type: "string", description: "Filter by reservation date in YYYY-MM-DD format" }, + status: { + type: "string", + description: "Filter by reservation status", + enum: ["pending", "confirmed", "seated", "completed", "cancelled", "no_show"] + }, + partySize: { type: "number", description: "Filter by party size" }, + }, + }, + }, + { + name: "create_reservation", + description: "Create a new reservation in TouchBistro", + inputSchema: { + type: "object" as const, + properties: { + customerName: { type: "string", description: "Customer name (required)" }, + customerPhone: { type: "string", description: "Customer phone number" }, + customerEmail: { type: "string", description: "Customer email address" }, + partySize: { type: "number", description: "Number of guests (required)" }, + date: { type: "string", description: "Reservation date in YYYY-MM-DD format (required)" }, + time: { type: "string", description: "Reservation time in HH:MM format (required)" }, + tableId: { type: "string", description: "Specific table ID to reserve" }, + notes: { type: "string", description: "Special requests or notes" }, + source: { + type: "string", + description: "Reservation source", + enum: ["phone", "walk_in", "online", "third_party"] + }, + }, + required: ["customerName", "partySize", "date", "time"], + }, + }, + { + name: "list_staff", + description: "List staff members from TouchBistro", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + role: { + type: "string", + description: "Filter by staff role", + enum: ["server", "bartender", "host", "manager", "kitchen", "cashier"] + }, + active: { type: "boolean", description: "Filter by active employment status" }, + }, + }, + }, + { + name: "get_sales_report", + description: "Get sales report data from TouchBistro for analysis and reporting", + inputSchema: { + type: "object" as const, + properties: { + startDate: { type: "string", description: "Report start date in YYYY-MM-DD format (required)" }, + endDate: { type: "string", description: "Report end date in YYYY-MM-DD format (required)" }, + groupBy: { + type: "string", + description: "How to group the report data", + enum: ["day", "week", "month", "category", "item", "server"] + }, + includeVoids: { type: "boolean", description: "Include voided orders in the report" }, + includeRefunds: { type: "boolean", description: "Include refunded orders in the report" }, + }, + required: ["startDate", "endDate"], + }, + }, +]; + +// ============================================ +// TOOL HANDLERS +// ============================================ +async function handleTool(client: TouchBistroClient, name: string, args: any) { + switch (name) { + case "list_orders": + return await client.listOrders(args); + + case "get_order": + return await client.getOrder(args.id); + + case "list_menu_items": + return await client.listMenuItems(args); + + case "list_reservations": + return await client.listReservations(args); + + case "create_reservation": + return await client.createReservation(args); + + case "list_staff": + return await client.listStaff(args); + + case "get_sales_report": + return await client.getSalesReport(args); + + default: + throw new Error(`Unknown tool: ${name}`); + } +} + +// ============================================ +// SERVER SETUP +// ============================================ +async function main() { + const apiKey = process.env.TOUCHBISTRO_API_KEY; + const venueId = process.env.TOUCHBISTRO_VENUE_ID; + + if (!apiKey) { + console.error("Error: TOUCHBISTRO_API_KEY environment variable required"); + process.exit(1); + } + + if (!venueId) { + console.error("Error: TOUCHBISTRO_VENUE_ID environment variable required"); + process.exit(1); + } + + const client = new TouchBistroClient(apiKey, venueId); + + const server = new Server( + { name: `${MCP_NAME}-mcp`, version: MCP_VERSION }, + { capabilities: { tools: {} } } + ); + + server.setRequestHandler(ListToolsRequestSchema, async () => ({ + tools, + })); + + server.setRequestHandler(CallToolRequestSchema, async (request) => { + const { name, arguments: args } = request.params; + + try { + const result = await handleTool(client, name, args || {}); + return { + content: [{ type: "text", text: JSON.stringify(result, null, 2) }], + }; + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + return { + content: [{ type: "text", text: `Error: ${message}` }], + isError: true, + }; + } + }); + + const transport = new StdioServerTransport(); + await server.connect(transport); + console.error(`${MCP_NAME} MCP server running on stdio`); +} + +main().catch(console.error); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..de6431e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,15 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "NodeNext", + "moduleResolution": "NodeNext", + "outDir": "./dist", + "rootDir": "./src", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "declaration": true + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "dist"] +}