mcp-zenskar 1.1.14 → 1.2.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 +146 -128
- package/{src → dist}/mcp-config.json +79 -131
- package/dist/server.mjs +108 -0
- package/package.json +18 -11
- package/.github/workflows/npm-publish.yml +0 -50
- package/CHANGELOG.md +0 -118
- package/INSTALL.md +0 -115
- package/src/response-processor.js +0 -28
- package/src/server.js +0 -1600
- package/src/ui/shapes/app.html +0 -12
package/README.md
CHANGED
|
@@ -43,11 +43,13 @@ Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/
|
|
|
43
43
|
### For Other AI Applications
|
|
44
44
|
|
|
45
45
|
Install globally:
|
|
46
|
+
|
|
46
47
|
```bash
|
|
47
48
|
npm install -g mcp-zenskar
|
|
48
49
|
```
|
|
49
50
|
|
|
50
51
|
Or run directly:
|
|
52
|
+
|
|
51
53
|
```bash
|
|
52
54
|
npx mcp-zenskar
|
|
53
55
|
```
|
|
@@ -84,167 +86,182 @@ Once configured, you can ask Claude to interact with your Zenskar data:
|
|
|
84
86
|
## Available Tools
|
|
85
87
|
|
|
86
88
|
### Customers
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
|
90
|
-
| `
|
|
91
|
-
| `
|
|
92
|
-
| `
|
|
93
|
-
| `
|
|
89
|
+
|
|
90
|
+
| Tool | Description |
|
|
91
|
+
| ----------------- | -------------------------------------------------------------------------------------------------------- |
|
|
92
|
+
| `listCustomers` | List customers with search, filtering, and pagination |
|
|
93
|
+
| `getCustomerById` | Get a customer by ID |
|
|
94
|
+
| `createCustomer` | Create a customer with address and tax info |
|
|
95
|
+
| `updateCustomer` | Update customer details (partial update) |
|
|
96
|
+
| `deleteCustomer` | Permanently delete a customer by ID (only allowed when they have no active contracts or unpaid invoices) |
|
|
94
97
|
|
|
95
98
|
### Contacts
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
99
|
+
|
|
100
|
+
| Tool | Description |
|
|
101
|
+
| ---------------- | ------------------------------- |
|
|
102
|
+
| `listContacts` | List contacts with pagination |
|
|
103
|
+
| `getContactById` | Get a contact by ID |
|
|
104
|
+
| `createContact` | Create a contact for a customer |
|
|
105
|
+
| `updateContact` | Update a contact's details |
|
|
106
|
+
| `deleteContact` | Delete a contact by ID |
|
|
103
107
|
|
|
104
108
|
### Contracts
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
|
108
|
-
| `
|
|
109
|
-
| `
|
|
110
|
-
| `
|
|
111
|
-
| `
|
|
112
|
-
| `
|
|
113
|
-
| `
|
|
114
|
-
| `
|
|
115
|
-
| `
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
109
|
+
|
|
110
|
+
| Tool | Description |
|
|
111
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
112
|
+
| `listContracts` | List contracts with filtering by status, customer, dates |
|
|
113
|
+
| `getContractById` | Get a contract with phases, pricings, and customer details |
|
|
114
|
+
| `createContract` | Create a contract with phases and pricing |
|
|
115
|
+
| `updateContract` | Update contract terms, status, pricing, or renewal policy |
|
|
116
|
+
| `deleteContract` | Delete a draft contract |
|
|
117
|
+
| `getContractAmendments` | Get amendment history for a contract |
|
|
118
|
+
| `createContractPhase` | Add a phase to a contract (add-ons, expansions) |
|
|
119
|
+
| `createContractPhasePricing` | Add pricing to a contract phase |
|
|
120
|
+
| `expireContract` | Expire an active contract |
|
|
121
|
+
| `pauseContract` | Pause an active contract from a given start date, with an unpause-extension policy (`extend` or `overlap`) and optional end date for auto-resume |
|
|
122
|
+
| `editPauseContract` | Edit an existing pause phase — set or change the resume date, shift the start, or change the unpause policy |
|
|
123
|
+
| `resumeContract` | Resume a paused contract |
|
|
124
|
+
| `createContractPrompt` | Create a contract prompt |
|
|
125
|
+
| `extractContractFromRaw` | Extract contract data from raw text using AI |
|
|
121
126
|
|
|
122
127
|
### Invoices
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
|
126
|
-
| `
|
|
127
|
-
| `
|
|
128
|
-
| `
|
|
129
|
-
| `
|
|
130
|
-
| `
|
|
131
|
-
| `
|
|
132
|
-
| `
|
|
128
|
+
|
|
129
|
+
| Tool | Description |
|
|
130
|
+
| ---------------------------------- | -------------------------------------------------------------------------- |
|
|
131
|
+
| `listInvoices` | List invoices with filtering by customer, status, dates |
|
|
132
|
+
| `getInvoiceById` | Get an invoice by ID |
|
|
133
|
+
| `getInvoiceByExternalId` | Get an invoice by external ID |
|
|
134
|
+
| `getInvoiceGenerationStatus` | Check invoice generation status |
|
|
135
|
+
| `downloadInvoice` | Download invoice in JSON format |
|
|
136
|
+
| `getInvoiceContractJsonActuals` | Get contract actuals for an invoice |
|
|
137
|
+
| `getInvoicePayments` | Get successful payments currently mapped to an invoice |
|
|
138
|
+
| `getInvoicePaymentsById` | Get successful payments for a specific invoice ID |
|
|
133
139
|
| `getInvoicePaymentsWithoutRefunds` | Get original payment records for an invoice, excluding refund payment rows |
|
|
134
|
-
| `getInvoiceLineItems`
|
|
135
|
-
| `getInvoiceSummary`
|
|
136
|
-
| `getAllInvoiceTags`
|
|
137
|
-
| `generateInvoicePaymentLink`
|
|
138
|
-
| `payInvoice`
|
|
139
|
-
| `approveInvoice`
|
|
140
|
-
| `voidInvoice`
|
|
141
|
-
| `deleteInvoice`
|
|
142
|
-
| `generateInvoice`
|
|
143
|
-
| `createInvoiceCreditNote`
|
|
144
|
-
| `createInvoiceCharge`
|
|
140
|
+
| `getInvoiceLineItems` | Get invoice line items and pricing details |
|
|
141
|
+
| `getInvoiceSummary` | Get invoice summary |
|
|
142
|
+
| `getAllInvoiceTags` | Get all available invoice tags |
|
|
143
|
+
| `generateInvoicePaymentLink` | Generate a payment link for an invoice |
|
|
144
|
+
| `payInvoice` | Initiate payment for an invoice |
|
|
145
|
+
| `approveInvoice` | Approve an invoice for billing |
|
|
146
|
+
| `voidInvoice` | Void an invoice |
|
|
147
|
+
| `deleteInvoice` | Delete a draft invoice |
|
|
148
|
+
| `generateInvoice` | Generate an invoice for a contract and date range |
|
|
149
|
+
| `createInvoiceCreditNote` | Create a credit note against an invoice |
|
|
150
|
+
| `createInvoiceCharge` | Auto-charge an invoice via payment gateway |
|
|
145
151
|
|
|
146
152
|
### Payments
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
|
150
|
-
| `
|
|
151
|
-
| `
|
|
152
|
-
| `
|
|
153
|
-
| `
|
|
154
|
-
| `
|
|
155
|
-
| `
|
|
153
|
+
|
|
154
|
+
| Tool | Description |
|
|
155
|
+
| --------------------- | ---------------------------------------------------------------------- |
|
|
156
|
+
| `listAllPayments` | List all payments with filtering and sorting, including refund records |
|
|
157
|
+
| `getPaymentById` | Get a payment by ID |
|
|
158
|
+
| `createPayment` | Record a payment against an invoice |
|
|
159
|
+
| `updatePayment` | Update a payment's invoice allocations (`payment_parts`) |
|
|
160
|
+
| `deleteManualPayment` | Delete a manual payment |
|
|
161
|
+
| `editManualPayment` | Edit a manual payment's amount or method |
|
|
162
|
+
| `refundPayment` | Refund a payment (full or partial) |
|
|
156
163
|
|
|
157
164
|
### Credit Notes
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
|
161
|
-
| `
|
|
165
|
+
|
|
166
|
+
| Tool | Description |
|
|
167
|
+
| ------------------- | --------------------------------- |
|
|
168
|
+
| `listCreditNotes` | List credit notes with pagination |
|
|
169
|
+
| `getCreditNoteById` | Get a credit note by ID |
|
|
162
170
|
|
|
163
171
|
### Products and Pricing
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
|
167
|
-
| `
|
|
168
|
-
| `
|
|
169
|
-
| `
|
|
170
|
-
| `
|
|
172
|
+
|
|
173
|
+
| Tool | Description |
|
|
174
|
+
| ---------------------- | ------------------------------------- |
|
|
175
|
+
| `listProducts` | List products in the catalog |
|
|
176
|
+
| `getProductById` | Get a product by ID |
|
|
177
|
+
| `createProduct` | Create a product |
|
|
178
|
+
| `updateProduct` | Update a product's details |
|
|
179
|
+
| `getProductPricings` | Get pricing configs for a product |
|
|
171
180
|
| `createProductPricing` | Create a pricing config for a product |
|
|
172
181
|
|
|
173
182
|
### Plans (Templates)
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
|
183
|
+
|
|
184
|
+
| Tool | Description |
|
|
185
|
+
| ------------- | ---------------------------------------- |
|
|
186
|
+
| `listPlans` | List plan templates |
|
|
177
187
|
| `getPlanById` | Get a plan by ID with phases and pricing |
|
|
178
|
-
| `createPlan`
|
|
188
|
+
| `createPlan` | Create a plan template |
|
|
179
189
|
|
|
180
190
|
### Accounting
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
|
184
|
-
| `
|
|
185
|
-
| `
|
|
186
|
-
| `
|
|
187
|
-
| `
|
|
188
|
-
| `
|
|
189
|
-
| `
|
|
190
|
-
| `
|
|
191
|
-
| `
|
|
192
|
-
| `
|
|
193
|
-
| `
|
|
191
|
+
|
|
192
|
+
| Tool | Description |
|
|
193
|
+
| -------------------- | ---------------------------------------- |
|
|
194
|
+
| `getChartOfAccounts` | Get the full chart of accounts |
|
|
195
|
+
| `listAccounts` | List GL accounts with filtering |
|
|
196
|
+
| `createAccount` | Create a GL account |
|
|
197
|
+
| `listJournalEntries` | List journal entries with filtering |
|
|
198
|
+
| `createJournalEntry` | Create a manual journal entry |
|
|
199
|
+
| `getJournalEntry` | Get a journal entry by ID with all lines |
|
|
200
|
+
| `listJournalLines` | List journal lines across all entries |
|
|
201
|
+
| `getBalanceSheet` | Get the balance sheet report |
|
|
202
|
+
| `getIncomeStatement` | Get the income statement (P&L) |
|
|
203
|
+
| `getAccountBalance` | Get balance for a specific GL account |
|
|
204
|
+
| `recogniseRevenue` | Trigger revenue recognition up to a date |
|
|
194
205
|
|
|
195
206
|
### Custom Attributes and Tax
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
|
207
|
+
|
|
208
|
+
| Tool | Description |
|
|
209
|
+
| ----------------------- | ------------------------------------ |
|
|
210
|
+
| `listCustomAttributes` | List custom attribute definitions |
|
|
199
211
|
| `createCustomAttribute` | Create a custom attribute definition |
|
|
200
|
-
| `listTaxCategories`
|
|
201
|
-
| `createTaxCategory`
|
|
212
|
+
| `listTaxCategories` | List tax categories |
|
|
213
|
+
| `createTaxCategory` | Create a tax category |
|
|
202
214
|
|
|
203
215
|
### Jobs
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
|
207
|
-
| `
|
|
216
|
+
|
|
217
|
+
| Tool | Description |
|
|
218
|
+
| ------------ | -------------------------------------------- |
|
|
219
|
+
| `listJobs` | List async jobs (invoice gen, rev rec, etc.) |
|
|
220
|
+
| `getJobById` | Get a job by ID to check status |
|
|
208
221
|
|
|
209
222
|
### Business Entities
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
|
223
|
+
|
|
224
|
+
| Tool | Description |
|
|
225
|
+
| ----------------------- | --------------------------- |
|
|
226
|
+
| `listBusinessEntities` | List business entities |
|
|
213
227
|
| `getBusinessEntityById` | Get a business entity by ID |
|
|
214
|
-
| `createBusinessEntity`
|
|
215
|
-
| `updateBusinessEntity`
|
|
228
|
+
| `createBusinessEntity` | Create a business entity |
|
|
229
|
+
| `updateBusinessEntity` | Update a business entity |
|
|
216
230
|
|
|
217
231
|
### Customer Addresses and Payment Methods
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
|
221
|
-
| `
|
|
222
|
-
| `
|
|
223
|
-
| `
|
|
224
|
-
| `
|
|
225
|
-
| `
|
|
232
|
+
|
|
233
|
+
| Tool | Description |
|
|
234
|
+
| ----------------------- | --------------------------------------- |
|
|
235
|
+
| `listCustomerAddresses` | List addresses for a customer |
|
|
236
|
+
| `createCustomerAddress` | Add an address to a customer |
|
|
237
|
+
| `updateCustomerAddress` | Update a customer address |
|
|
238
|
+
| `listPaymentMethods` | List payment methods for a customer |
|
|
239
|
+
| `attachPaymentMethod` | Attach a payment method to a customer |
|
|
240
|
+
| `deletePaymentMethod` | Delete a payment method from a customer |
|
|
226
241
|
|
|
227
242
|
### Metrics and Usage Events
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
|
231
|
-
| `
|
|
232
|
-
| `
|
|
233
|
-
| `
|
|
234
|
-
| `
|
|
235
|
-
| `
|
|
236
|
-
| `
|
|
237
|
-
| `
|
|
238
|
-
| `
|
|
239
|
-
| `
|
|
240
|
-
| `
|
|
243
|
+
|
|
244
|
+
| Tool | Description |
|
|
245
|
+
| ----------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
246
|
+
| `listAggregates` | List Billable Metrics with filtering; backend/API may also call these aggregates |
|
|
247
|
+
| `getAggregateSchemas` | Show the underlying schemas for Billable Metrics (Aggregates); mainly useful for debugging or integration work |
|
|
248
|
+
| `getAggregateEstimates` | Get Billable Metric estimates; backend/API may also call these aggregates |
|
|
249
|
+
| `getAggregateById` | Get a Billable Metric by ID; backend/API may also call it an aggregate |
|
|
250
|
+
| `getAggregateLogs` | Get logs for a Billable Metric (Aggregate) |
|
|
251
|
+
| `listRawMetrics` | List Usage Events with filtering; backend/API may also call these raw metrics |
|
|
252
|
+
| `createRawMetric` | Create a Usage Event schema; backend/API calls this a raw metric |
|
|
253
|
+
| `getRawMetricById` | Get a Usage Event by ID; backend/API may also call it a raw metric |
|
|
254
|
+
| `getRawMetricLogs` | Get recent event rows for a Usage Event using the same preview-query path as the frontend |
|
|
255
|
+
| `getRawMetricBySlug` | Get a Usage Event by API slug; backend/API may also call it a raw metric |
|
|
256
|
+
| `ingestRawMetricEvent` | Ingest a usage event |
|
|
241
257
|
|
|
242
258
|
### Other
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
|
246
|
-
| `
|
|
247
|
-
| `
|
|
259
|
+
|
|
260
|
+
| Tool | Description |
|
|
261
|
+
| -------------------------------- | ----------------------------------------- |
|
|
262
|
+
| `createEntitlement` | Create an entitlement |
|
|
263
|
+
| `getCustomerPortalConfiguration` | Get customer portal config |
|
|
264
|
+
| `getCurrentDateTime` | Get current date/time in multiple formats |
|
|
248
265
|
|
|
249
266
|
## Security
|
|
250
267
|
|
|
@@ -302,5 +319,6 @@ MIT
|
|
|
302
319
|
## Support
|
|
303
320
|
|
|
304
321
|
For issues and support:
|
|
322
|
+
|
|
305
323
|
- GitHub Issues: https://github.com/zenskar/mcp-zenskar/issues
|
|
306
324
|
- Zenskar Documentation: https://docs.zenskar.com
|