@chanaka_nakandala/integration-agent 2.3.0 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -358
- package/package.json +2 -2
package/README.md
CHANGED
@@ -1,396 +1,89 @@
|
|
1
|
-
# Grubtech Integration
|
1
|
+
# Grubtech Integration Agent
|
2
2
|
|
3
|
-
|
4
|
-
> Get instant answers, generate code, and build Grubtech integrations faster
|
3
|
+
## What This Is
|
5
4
|
|
6
|
-
|
7
|
-
|
8
|
-
## 📖 What is This?
|
9
|
-
|
10
|
-
If you're a **restaurant, POS system, delivery platform, or cloud kitchen** building an integration with Grubtech APIs, this tool helps you work faster by providing:
|
11
|
-
|
12
|
-
- ✅ **Instant answers** to API questions (no more searching docs)
|
13
|
-
- ✅ **Production-ready code** in TypeScript, Python, Java, or cURL
|
14
|
-
- ✅ **AI guidance** from specialized Developer and Business Analyst agents
|
15
|
-
- ✅ **Smart documentation search** using natural language
|
16
|
-
|
17
|
-
**Example:** Instead of searching docs for 30 minutes, just ask:
|
18
|
-
*"How do I authenticate with Grubtech?"* → Get working code instantly.
|
19
|
-
|
20
|
-
---
|
21
|
-
|
22
|
-
## 🍔 What is Grubtech?
|
5
|
+
This is an easy setup tool for connecting your restaurant system with Grubtech. Just run one simple command, and it installs an AI helper inside your Claude Code app that answers questions and writes code for you.
|
23
6
|
|
24
|
-
|
25
|
-
- Cloud kitchens and virtual restaurants
|
26
|
-
- Multi-channel online ordering (delivery apps, web, mobile)
|
27
|
-
- Menu management across platforms
|
28
|
-
- Order aggregation and kitchen operations
|
7
|
+
## What You Can Do With This
|
29
8
|
|
30
|
-
**
|
9
|
+
- **Ask questions** about Grubtech and get instant answers
|
10
|
+
- **Get code examples** in TypeScript, Python, Java, or cURL
|
11
|
+
- **Build integrations faster** with AI-powered help
|
12
|
+
- **Search documentation** without opening a browser
|
31
13
|
|
32
|
-
|
33
|
-
- 🌐 Website: https://www.grubtech.com
|
34
|
-
- 📚 API Documentation: https://docs.grubtech.io
|
35
|
-
- 📧 Support: support@grubtech.io
|
36
|
-
|
37
|
-
---
|
38
|
-
|
39
|
-
## 👥 Who Should Use This?
|
40
|
-
|
41
|
-
This tool is perfect for **external developers** who are:
|
42
|
-
|
43
|
-
✅ **Restaurant/POS Developers** - Integrating your point-of-sale system with Grubtech
|
44
|
-
✅ **Delivery Platform Engineers** - Building order sync between your platform and Grubtech
|
45
|
-
✅ **Cloud Kitchen Tech Teams** - Connecting kitchen management systems
|
46
|
-
✅ **Integration Consultants** - Building custom integrations for clients
|
47
|
-
✅ **Technical Partners** - Developing apps in the Grubtech ecosystem
|
48
|
-
|
49
|
-
**No prior Grubtech experience needed!** This AI assistant guides you through the entire process.
|
50
|
-
|
51
|
-
---
|
14
|
+
## Who Should Use This
|
52
15
|
|
53
|
-
|
16
|
+
- Restaurant and POS developers
|
17
|
+
- Delivery platform engineers
|
18
|
+
- Anyone building integrations with Grubtech
|
19
|
+
- Technical teams at cloud kitchens
|
54
20
|
|
55
|
-
|
21
|
+
No prior Grubtech experience needed!
|
56
22
|
|
57
|
-
|
58
|
-
- **Claude Desktop or Claude Code** - [Download](https://claude.ai/)
|
23
|
+
## How to Install
|
59
24
|
|
60
|
-
|
61
|
-
|
62
|
-
Run this **ONE command** in your terminal:
|
25
|
+
Open your terminal and run this single command:
|
63
26
|
|
64
27
|
```bash
|
65
28
|
npx @chanaka_nakandala/integration-agent init
|
66
29
|
```
|
67
30
|
|
68
|
-
That's it!
|
69
|
-
- ✅ AI-powered MCP server for Claude Code
|
70
|
-
- ✅ 2 specialized AI agent personas (Developer & Business Analyst)
|
71
|
-
- ✅ 20 production-ready code templates
|
72
|
-
- ✅ Intelligent documentation search
|
73
|
-
|
74
|
-
**Then:**
|
75
|
-
1. Restart Claude Code
|
76
|
-
2. Select an agent persona from the menu
|
77
|
-
3. Start asking questions!
|
78
|
-
|
79
|
-
---
|
80
|
-
|
81
|
-
## 💬 How to Use
|
31
|
+
That's it! Then restart Claude Code and start asking questions.
|
82
32
|
|
83
|
-
|
33
|
+
## What Features This Supports
|
84
34
|
|
85
|
-
**
|
86
|
-
|
87
|
-
|
88
|
-
|
35
|
+
**AI Chat Assistant**
|
36
|
+
- Ask any question about Grubtech APIs
|
37
|
+
- Get instant answers without searching docs
|
38
|
+
- Works directly inside Claude Code
|
89
39
|
|
90
|
-
**
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
40
|
+
**Code Generation**
|
41
|
+
- Authentication code
|
42
|
+
- Menu synchronization
|
43
|
+
- Order receiving from Grubtech
|
44
|
+
- Order status updates
|
45
|
+
- Item availability management
|
95
46
|
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
headers: { 'Content-Type': 'application/json' },
|
100
|
-
body: JSON.stringify({ apiKey: API_KEY, partnerId: PARTNER_ID })
|
101
|
-
});
|
47
|
+
**Two AI Helpers**
|
48
|
+
- **Developer Agent**: For writing code and technical questions
|
49
|
+
- **Business Analyst Agent**: For planning projects and requirements
|
102
50
|
|
103
|
-
|
104
|
-
|
105
|
-
|
51
|
+
**Documentation Search**
|
52
|
+
- Find information from Grubtech docs instantly
|
53
|
+
- No need to browse websites
|
54
|
+
- Works with natural language questions
|
106
55
|
|
107
|
-
|
108
|
-
return accessToken;
|
109
|
-
}
|
110
|
-
```
|
111
|
-
|
112
|
-
### Example 2: Search Documentation
|
56
|
+
## Example Usage
|
113
57
|
|
114
58
|
**You ask:**
|
115
59
|
```
|
116
|
-
How do
|
60
|
+
How do I authenticate with Grubtech?
|
117
61
|
```
|
118
62
|
|
119
|
-
**
|
120
|
-
|
121
|
-
|
122
|
-
### Example 3: Planning Your Integration
|
63
|
+
**AI responds with:**
|
64
|
+
Complete working code ready to use in your project.
|
123
65
|
|
124
66
|
**You ask:**
|
125
67
|
```
|
126
|
-
Help me
|
68
|
+
Help me build a menu sync integration
|
127
69
|
```
|
128
70
|
|
129
|
-
**
|
130
|
-
-
|
131
|
-
- Identifies integration requirements
|
132
|
-
- Creates a comprehensive project plan with architecture diagrams
|
133
|
-
- Provides a handoff document for implementation
|
134
|
-
|
135
|
-
---
|
136
|
-
|
137
|
-
## 🤖 Two AI Agent Personas
|
138
|
-
|
139
|
-
### 🔧 Developer Agent (Technical Implementation)
|
140
|
-
|
141
|
-
**When to use:** You're ready to write code
|
71
|
+
**AI responds with:**
|
72
|
+
Step-by-step guidance and code examples.
|
142
73
|
|
143
|
-
|
144
|
-
- Generates production-ready code in TypeScript, Python, Java, or cURL
|
145
|
-
- Provides API specifications and technical details
|
146
|
-
- Helps debug API errors with specific solutions
|
147
|
-
- Technical, concise, code-first responses
|
74
|
+
## What Grubtech Is
|
148
75
|
|
149
|
-
|
150
|
-
- "Generate Python code for menu synchronization"
|
151
|
-
- "How do I handle order status updates in Java?"
|
152
|
-
- "Show me cURL examples for item availability"
|
76
|
+
Grubtech is a restaurant technology platform for online ordering, menu management, and kitchen operations. If you're connecting your system to Grubtech, this tool makes the job easier.
|
153
77
|
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
**What it does:**
|
159
|
-
- Asks discovery questions about your integration needs
|
160
|
-
- Gathers comprehensive requirements
|
161
|
-
- Creates project documentation with architecture diagrams
|
162
|
-
- Provides process guidance and go-live checklists
|
163
|
-
- Explanatory, question-driven, process-oriented responses
|
164
|
-
|
165
|
-
**Example questions:**
|
166
|
-
- "Help me plan my integration with Grubtech"
|
167
|
-
- "What do I need to know before starting?"
|
168
|
-
- "Create a requirements document for my POS integration"
|
169
|
-
|
170
|
-
**💡 Best Practice:** Start with BA Agent for planning → Switch to Developer Agent for coding
|
171
|
-
|
172
|
-
---
|
173
|
-
|
174
|
-
## 🛠️ Common Integration Scenarios
|
175
|
-
|
176
|
-
This tool helps with all major Grubtech integration scenarios:
|
177
|
-
|
178
|
-
### 1. **Authentication**
|
179
|
-
Get access tokens to call Grubtech APIs securely.
|
180
|
-
|
181
|
-
**Ask Claude:** *"How do I authenticate?"*
|
182
|
-
|
183
|
-
### 2. **Menu Synchronization**
|
184
|
-
Push your menu items, modifiers, and pricing to Grubtech.
|
185
|
-
|
186
|
-
**Ask Claude:** *"Generate code to sync my menu"*
|
187
|
-
|
188
|
-
### 3. **Receiving Orders**
|
189
|
-
Handle incoming order webhooks from Grubtech when customers place orders.
|
190
|
-
|
191
|
-
**Ask Claude:** *"How do I receive orders from Grubtech?"*
|
192
|
-
|
193
|
-
### 4. **Order Status Updates**
|
194
|
-
Update Grubtech when orders are accepted, prepared, or delivered.
|
195
|
-
|
196
|
-
**Ask Claude:** *"Show me how to update order status"*
|
197
|
-
|
198
|
-
### 5. **Item Availability**
|
199
|
-
Toggle menu items on/off when they're out of stock.
|
200
|
-
|
201
|
-
**Ask Claude:** *"How do I mark items as unavailable?"*
|
202
|
-
|
203
|
-
---
|
204
|
-
|
205
|
-
## 📚 Available Code Templates
|
206
|
-
|
207
|
-
20 production-ready templates for common operations:
|
208
|
-
|
209
|
-
| Operation | TypeScript | Python | Java | cURL |
|
210
|
-
|-----------|:----------:|:------:|:----:|:----:|
|
211
|
-
| **Authentication** | ✅ | ✅ | ✅ | ✅ |
|
212
|
-
| **Menu Sync** | ✅ | ✅ | ✅ | ✅ |
|
213
|
-
| **Order Receive** | ✅ | ✅ | ✅ | ✅ |
|
214
|
-
| **Order Status** | ✅ | ✅ | ✅ | ✅ |
|
215
|
-
| **Item Availability** | ✅ | ✅ | ✅ | ✅ |
|
216
|
-
|
217
|
-
Each template includes:
|
218
|
-
- ✅ Complete working code
|
219
|
-
- ✅ Error handling and logging
|
220
|
-
- ✅ Type definitions (TypeScript/Python/Java)
|
221
|
-
- ✅ Inline documentation
|
222
|
-
- ✅ Placeholder markers for your credentials
|
223
|
-
- ✅ Example usage
|
224
|
-
|
225
|
-
---
|
226
|
-
|
227
|
-
## 🔐 Privacy & Security
|
228
|
-
|
229
|
-
- **100% Local** - All processing happens on your machine
|
230
|
-
- **No Data Collection** - Zero telemetry or analytics
|
231
|
-
- **No External API Calls** - Works offline (after initial doc scraping)
|
232
|
-
- **Open Source** - Audit the code yourself
|
233
|
-
- **No API Keys Required** - Templates use placeholders for your keys
|
234
|
-
|
235
|
-
Your code and credentials **never leave your machine**.
|
236
|
-
|
237
|
-
---
|
78
|
+
**Learn more:**
|
79
|
+
- Website: https://www.grubtech.com
|
80
|
+
- Documentation: https://docs.grubtech.io
|
81
|
+
- Support: support@grubtech.io
|
238
82
|
|
239
|
-
##
|
240
|
-
|
241
|
-
### Within Claude Code
|
242
|
-
Just ask! The AI agents can help with:
|
243
|
-
- API questions
|
244
|
-
- Code errors
|
245
|
-
- Integration planning
|
246
|
-
- Best practices
|
247
|
-
|
248
|
-
### External Resources
|
249
|
-
- 📚 Grubtech API Docs: https://docs.grubtech.io
|
250
|
-
- 🌐 Grubtech Website: https://www.grubtech.com
|
251
|
-
- 📧 Email Support: support@grubtech.io
|
252
|
-
|
253
|
-
### Common Questions
|
254
|
-
|
255
|
-
**Q: Do I need a Grubtech account?**
|
256
|
-
A: Yes, you'll need API credentials from Grubtech. Contact support@grubtech.io to get started.
|
257
|
-
|
258
|
-
**Q: Which programming language should I use?**
|
259
|
-
A: Use whatever your existing system is built with. This tool supports TypeScript, Python, Java, and cURL.
|
260
|
-
|
261
|
-
**Q: Is this tool official from Grubtech?**
|
262
|
-
A: This is a developer tool built to help with Grubtech integrations. For official support, contact Grubtech directly.
|
263
|
-
|
264
|
-
**Q: Do I need to know Grubtech APIs beforehand?**
|
265
|
-
A: No! The AI agents guide you through everything. Start with the BA Agent to learn the basics.
|
266
|
-
|
267
|
-
---
|
268
|
-
|
269
|
-
## 🚀 What You Can Build
|
270
|
-
|
271
|
-
Examples of integrations developers have built:
|
272
|
-
|
273
|
-
- **Restaurant POS Systems** - Sync menus, receive orders, update status
|
274
|
-
- **Delivery Management Platforms** - Route orders, track deliveries, update statuses
|
275
|
-
- **Kitchen Display Systems** - Receive orders, mark as prepared
|
276
|
-
- **Inventory Management** - Update item availability based on stock
|
277
|
-
- **Custom Ordering Websites** - Pull menus, create orders, track status
|
278
|
-
- **Multi-Brand Aggregators** - Manage menus across multiple virtual brands
|
279
|
-
|
280
|
-
---
|
281
|
-
|
282
|
-
## 📝 Typical Integration Workflow
|
283
|
-
|
284
|
-
### Phase 1: Planning (Use BA Agent)
|
285
|
-
1. Ask: *"Help me plan my integration"*
|
286
|
-
2. Answer discovery questions about your system
|
287
|
-
3. Review generated requirements document
|
288
|
-
|
289
|
-
### Phase 2: Setup
|
290
|
-
1. Get API credentials from Grubtech
|
291
|
-
2. Set up authentication
|
292
|
-
3. Test connectivity
|
293
|
-
|
294
|
-
### Phase 3: Implementation (Use Developer Agent)
|
295
|
-
1. Implement menu synchronization
|
296
|
-
2. Set up order webhook receiver
|
297
|
-
3. Implement order status updates
|
298
|
-
4. Add item availability management
|
299
|
-
|
300
|
-
### Phase 4: Testing
|
301
|
-
1. Test in Grubtech sandbox environment
|
302
|
-
2. Validate data flows
|
303
|
-
3. Handle edge cases
|
304
|
-
|
305
|
-
### Phase 5: Go-Live
|
306
|
-
1. Complete Grubtech certification
|
307
|
-
2. Deploy to production
|
308
|
-
3. Monitor integration health
|
309
|
-
|
310
|
-
**💡 The AI agents guide you through each phase!**
|
311
|
-
|
312
|
-
---
|
313
|
-
|
314
|
-
## 💻 Example Session
|
315
|
-
|
316
|
-
```
|
317
|
-
You: Help me start a POS integration with Grubtech
|
318
|
-
|
319
|
-
BA Agent: I'll help you plan this integration. Let me ask a few questions:
|
320
|
-
|
321
|
-
1. What type of system are you integrating?
|
322
|
-
- POS System, Delivery Platform, Kitchen Display, or Other?
|
323
|
-
|
324
|
-
2. What's your tech stack?
|
325
|
-
- Language/framework you're using?
|
326
|
-
|
327
|
-
3. What capabilities do you need?
|
328
|
-
- Menu sync, order receiving, status updates?
|
329
|
-
|
330
|
-
[You answer the questions...]
|
331
|
-
|
332
|
-
BA Agent: Based on your requirements, I've created a comprehensive
|
333
|
-
integration plan. See docs/integration-requirements.md
|
334
|
-
|
335
|
-
Next step: Switch to "Developer Agent" to start implementation.
|
336
|
-
|
337
|
-
---
|
338
|
-
|
339
|
-
You: [Switch to Developer Agent]
|
340
|
-
I have the requirements document. Let's start with authentication.
|
341
|
-
|
342
|
-
Developer Agent: I'll generate TypeScript authentication code for you.
|
343
|
-
[Provides complete working code with error handling...]
|
344
|
-
```
|
345
|
-
|
346
|
-
---
|
347
|
-
|
348
|
-
## 🌟 Why Use This Tool?
|
349
|
-
|
350
|
-
### Without This Tool:
|
351
|
-
- ⏰ Spend hours searching documentation
|
352
|
-
- 📄 Copy/paste code examples that don't quite fit
|
353
|
-
- ❓ Get stuck on API errors with unclear messages
|
354
|
-
- 🔄 Repeatedly ask the same questions
|
355
|
-
|
356
|
-
### With This Tool:
|
357
|
-
- ⚡ Get instant answers in Claude Code
|
358
|
-
- 💻 Generate code tailored to your language
|
359
|
-
- 🤖 AI agents guide you step-by-step
|
360
|
-
- 📚 Smart search finds exactly what you need
|
361
|
-
|
362
|
-
**Result:** Build integrations **5-10x faster** with fewer errors.
|
363
|
-
|
364
|
-
---
|
365
|
-
|
366
|
-
## 📄 License
|
367
|
-
|
368
|
-
MIT © Grubtech
|
369
|
-
|
370
|
-
Free to use for commercial and personal projects.
|
371
|
-
|
372
|
-
---
|
373
|
-
|
374
|
-
## 🔗 Links
|
375
|
-
|
376
|
-
- **Grubtech Website:** https://www.grubtech.com
|
377
|
-
- **API Documentation:** https://docs.grubtech.io
|
378
|
-
- **Email Support:** support@grubtech.io
|
379
|
-
- **NPM Package:** https://www.npmjs.com/package/@chanaka_nakandala/integration-agent
|
380
|
-
|
381
|
-
---
|
382
|
-
|
383
|
-
## 🎉 Ready to Start?
|
384
|
-
|
385
|
-
Install with ONE command:
|
386
|
-
|
387
|
-
```bash
|
388
|
-
npx @chanaka_nakandala/integration-agent init
|
389
|
-
```
|
83
|
+
## Getting Help
|
390
84
|
|
391
|
-
|
85
|
+
Just ask questions inside Claude Code after installation, or contact Grubtech support at support@grubtech.io
|
392
86
|
|
393
87
|
---
|
394
88
|
|
395
|
-
|
396
|
-
*Questions? Ask the AI agents in Claude Code or contact support@grubtech.io*
|
89
|
+
© 2025 Grubtech. All rights reserved.
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@chanaka_nakandala/integration-agent",
|
3
|
-
"version": "2.3.
|
3
|
+
"version": "2.3.1",
|
4
4
|
"description": "One-command installer that sets up the complete Grubtech Integration Agent (MCP server + AI agent personas) for Claude Code to help developers build restaurant and POS integrations.",
|
5
5
|
"type": "module",
|
6
6
|
"main": "./dist/index.js",
|
@@ -56,7 +56,7 @@
|
|
56
56
|
"author": "Grubtech <support@grubtech.io>",
|
57
57
|
"license": "MIT",
|
58
58
|
"dependencies": {
|
59
|
-
"@chanaka_nakandala/integration-personas": "^1.0.
|
59
|
+
"@chanaka_nakandala/integration-personas": "^1.0.1"
|
60
60
|
},
|
61
61
|
"devDependencies": {
|
62
62
|
"@types/node": "^20.0.0",
|