@casys/mcp-erpnext 2.4.1 → 2.5.0
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 +42 -29
- package/mcp-erpnext.mjs +903 -351
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,10 @@ Copilot, custom) to your ERPNext instance via the
|
|
|
15
15
|
|
|
16
16
|
Works with **self-hosted** and **ERPNext Cloud** (frappe.cloud) instances.
|
|
17
17
|
|
|
18
|
+
> Built on **[@casys/mcp-server](https://github.com/Casys-AI/mcp-server)** — the
|
|
19
|
+
> MCP server framework (concurrency, auth, MCP Apps, observability) that powers
|
|
20
|
+
> this project.
|
|
21
|
+
|
|
18
22
|
## Screenshots
|
|
19
23
|
|
|
20
24
|
Interactive viewers rendered inside an MCP host, driven entirely by tool
|
|
@@ -101,8 +105,6 @@ Generate API credentials in ERPNext:
|
|
|
101
105
|
> (e.g. `https://mycompany.erpnext.com` or `https://mysite.frappe.cloud`). API
|
|
102
106
|
> key authentication works the same way on self-hosted and cloud instances.
|
|
103
107
|
|
|
104
|
-
> Zero dependencies — single self-contained bundle. Requires Node >= 20.
|
|
105
|
-
|
|
106
108
|
### VS Code Copilot
|
|
107
109
|
|
|
108
110
|
Add to `.vscode/mcp.json`:
|
|
@@ -151,6 +153,9 @@ ERPNEXT_API_SECRET=xxx \
|
|
|
151
153
|
npx -y @casys/mcp-erpnext --http --port=3012
|
|
152
154
|
```
|
|
153
155
|
|
|
156
|
+
> **Note:** HTTP mode binds to `127.0.0.1` (loopback) by default as of v2.4.2.
|
|
157
|
+
> For Docker or multi-host setups, add `--hostname=0.0.0.0`.
|
|
158
|
+
|
|
154
159
|
### Deno (HTTP mode)
|
|
155
160
|
|
|
156
161
|
```bash
|
|
@@ -208,8 +213,7 @@ viewers, registered as `ui://mcp-erpnext/{name}`:
|
|
|
208
213
|
|
|
209
214
|
Viewers communicate via `app.sendMessage()` — clicking a button in one viewer
|
|
210
215
|
injects a message into the conversation, which triggers the AI to call the right
|
|
211
|
-
tool and open the appropriate viewer.
|
|
212
|
-
experience without leaving the chat.
|
|
216
|
+
tool and open the appropriate viewer.
|
|
213
217
|
|
|
214
218
|
The server auto-injects navigation metadata into tool results:
|
|
215
219
|
|
|
@@ -237,28 +241,32 @@ node build-all.mjs
|
|
|
237
241
|
|
|
238
242
|
## Tools (123)
|
|
239
243
|
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
244
|
+
123 tools across 14 categories. Each `_list` tool returns interactive results
|
|
245
|
+
via the doclist-viewer with row click, inline detail, and cross-viewer
|
|
246
|
+
navigation.
|
|
247
|
+
|
|
248
|
+
- **Sales** (17) — Customers, Sales Orders, Invoices, and Quotations with full
|
|
249
|
+
CRUD, Submit, and Cancel.
|
|
250
|
+
- **Purchasing** (11) — Suppliers, Purchase Orders, Purchase Invoices, Receipts,
|
|
251
|
+
and Supplier Quotations.
|
|
252
|
+
- **Inventory** (9) — Items, Stock Balance, Warehouses, and Stock Entries.
|
|
253
|
+
- **Accounting** (6) — Chart of Accounts, Journal Entries, and Payment Entries.
|
|
254
|
+
- **HR** (12) — Employees, Attendance, Leave Applications, Salary Slips, Payroll
|
|
255
|
+
Entries, and Expense Claims.
|
|
256
|
+
- **Project** (9) — Projects, Tasks (with native assignment), and Timesheets.
|
|
257
|
+
- **Delivery** (5) — Delivery Notes and Shipments.
|
|
258
|
+
- **Manufacturing** (7) — BOMs, Work Orders, and Job Cards.
|
|
259
|
+
- **CRM** (8) — Leads, Opportunities, Contacts, and Campaigns.
|
|
260
|
+
- **Assets** (8) — Assets, Movements, Maintenance records, and Categories.
|
|
261
|
+
- **Operations** (9) — Generic CRUD and native assignment for any DocType
|
|
262
|
+
(`erpnext_doc_*`).
|
|
263
|
+
- **Kanban** (2) — Read-write boards for Task, Opportunity, and Issue with
|
|
264
|
+
drag-and-drop.
|
|
265
|
+
- **Analytics** (17) — 11 analytics charts (bar, area, treemap, radar, scatter,
|
|
266
|
+
P&L…), 5 KPIs with sparklines, and a sales funnel.
|
|
267
|
+
- **Setup** (3) — Company creation and assignable user listing.
|
|
268
|
+
|
|
269
|
+
Full per-tool reference with parameters: [`docs/tools.md`](docs/tools.md).
|
|
262
270
|
|
|
263
271
|
## Environment Variables
|
|
264
272
|
|
|
@@ -293,8 +301,8 @@ src/
|
|
|
293
301
|
manufacturing.ts # 7 manufacturing tools
|
|
294
302
|
crm.ts # 8 CRM tools
|
|
295
303
|
assets.ts # 8 asset tools
|
|
296
|
-
operations.ts #
|
|
297
|
-
setup.ts #
|
|
304
|
+
operations.ts # 9 generic CRUD tools
|
|
305
|
+
setup.ts # 3 company/setup tools
|
|
298
306
|
kanban.ts # 2 read-write kanban tools
|
|
299
307
|
analytics.ts # 17 analytics tools (charts, KPIs, funnel)
|
|
300
308
|
ui-refresh.ts # Auto-inject _rowAction, _sendMessageHints, _drillDown
|
|
@@ -322,7 +330,7 @@ docs/
|
|
|
322
330
|
## npm Package
|
|
323
331
|
|
|
324
332
|
The npm package (`@casys/mcp-erpnext`) is a single self-contained bundle with
|
|
325
|
-
zero runtime dependencies. UI viewers are embedded.
|
|
333
|
+
zero runtime dependencies. UI viewers are embedded. Requires Node >= 20.
|
|
326
334
|
|
|
327
335
|
## Development
|
|
328
336
|
|
|
@@ -349,6 +357,11 @@ deno task release:check
|
|
|
349
357
|
cd src/ui && npm run dev:kanban
|
|
350
358
|
```
|
|
351
359
|
|
|
360
|
+
## Contributing
|
|
361
|
+
|
|
362
|
+
Contributions are welcome — see **[CONTRIBUTING.md](CONTRIBUTING.md)** to get
|
|
363
|
+
started, and [AGENTS.md](AGENTS.md) for the full architecture and conventions.
|
|
364
|
+
|
|
352
365
|
## Release Flow
|
|
353
366
|
|
|
354
367
|
Releases are manual and explicit:
|