@kelviq/mcp-server 1.0.0 → 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.
Files changed (46) hide show
  1. package/README.md +25 -7
  2. package/dist/docs/README.md +16 -0
  3. package/dist/docs/backend-integration/node-sdk.md +41 -17
  4. package/dist/docs/backend-integration/python-sdk.md +16 -17
  5. package/dist/docs/changelog.md +4076 -0
  6. package/dist/docs/cli/commands.md +140 -5
  7. package/dist/docs/cli/environments.md +3 -3
  8. package/dist/docs/cli/kelviq-config.md +28 -7
  9. package/dist/docs/cli/overview.md +11 -9
  10. package/dist/docs/guides/agent-toolkit.md +3 -3
  11. package/dist/docs/guides/mcp-server.md +36 -5
  12. package/dist/docs/guides/webhooks.md +1 -1
  13. package/dist/docs/manifest.json +5 -61
  14. package/dist/docs/product-catalog/free-and-trials.md +13 -0
  15. package/dist/docs/product-catalog/license-keys.md +13 -0
  16. package/dist/http/client.d.ts +7 -0
  17. package/dist/http/client.js +9 -0
  18. package/dist/http/client.js.map +1 -1
  19. package/dist/prompts/index.js +11 -11
  20. package/dist/prompts/index.js.map +1 -1
  21. package/dist/schemas/kelviq.d.ts +200 -0
  22. package/dist/schemas/kelviq.js +178 -3
  23. package/dist/schemas/kelviq.js.map +1 -1
  24. package/dist/server.js +2 -0
  25. package/dist/server.js.map +1 -1
  26. package/dist/tools/_resolve.d.ts +4 -0
  27. package/dist/tools/_resolve.js +46 -0
  28. package/dist/tools/_resolve.js.map +1 -0
  29. package/dist/tools/connection.d.ts +12 -0
  30. package/dist/tools/connection.js +44 -0
  31. package/dist/tools/connection.js.map +1 -0
  32. package/dist/tools/discounts.d.ts +3 -0
  33. package/dist/tools/discounts.js +86 -0
  34. package/dist/tools/discounts.js.map +1 -0
  35. package/dist/tools/index.js +7 -0
  36. package/dist/tools/index.js.map +1 -1
  37. package/dist/tools/offerings.js +6 -2
  38. package/dist/tools/offerings.js.map +1 -1
  39. package/dist/tools/plan-entitlements.js +11 -3
  40. package/dist/tools/plan-entitlements.js.map +1 -1
  41. package/dist/tools/plans.js +6 -2
  42. package/dist/tools/plans.js.map +1 -1
  43. package/dist/tools/webhooks.d.ts +10 -0
  44. package/dist/tools/webhooks.js +114 -0
  45. package/dist/tools/webhooks.js.map +1 -0
  46. package/package.json +1 -1
@@ -0,0 +1,114 @@
1
+ import { ListWebhookEndpoints, ListWebhookLogs, WebhookEndpointCreate, WebhookEndpointDelete, WebhookEndpointRetrieve, WebhookEndpointUpdate, } from '../schemas/kelviq.js';
2
+ import { resultToContent } from './_util.js';
3
+ export const HIDDEN_SECRET = '[hidden — pass revealSecret: true to include it, or write it straight to the app env file with a command]';
4
+ /**
5
+ * The webhook endpoint API returns the signing secret on list, create,
6
+ * retrieve and update. Hide it unless the caller explicitly asks, so a secret
7
+ * doesn't land in the conversation just because an endpoint was looked at.
8
+ */
9
+ export function redactSecrets(value) {
10
+ if (Array.isArray(value))
11
+ return value.map(redactSecrets);
12
+ if (value !== null && typeof value === 'object') {
13
+ return Object.fromEntries(Object.entries(value).map(([key, v]) => [
14
+ key,
15
+ key === 'secret' && typeof v === 'string' && v.length > 0 ? HIDDEN_SECRET : redactSecrets(v),
16
+ ]));
17
+ }
18
+ return value;
19
+ }
20
+ function secretAware(result, revealSecret) {
21
+ return result.ok && !revealSecret ? { ok: true, data: redactSecrets(result.data) } : result;
22
+ }
23
+ export function registerWebhookTools(server, http) {
24
+ server.registerTool('webhook_endpoint_list', {
25
+ title: 'List webhook endpoints',
26
+ description: 'List registered webhook endpoints with their URLs, events and enabled state. Signing secrets are hidden unless revealSecret is true. Use this before creating an endpoint to avoid registering the same URL twice.',
27
+ annotations: { readOnlyHint: true },
28
+ inputSchema: ListWebhookEndpoints.shape,
29
+ }, async (input) => {
30
+ const result = await http.request({
31
+ method: 'GET',
32
+ path: '/webhook/endpoints/',
33
+ auth: 'server',
34
+ query: { page: input.page, page_size: input.pageSize },
35
+ });
36
+ return resultToContent(secretAware(result, input.revealSecret));
37
+ });
38
+ server.registerTool('webhook_endpoint_create', {
39
+ title: 'Create webhook endpoint',
40
+ description: 'Register a URL to receive webhook events. The URL must be publicly reachable — localhost and private addresses are rejected. A signing secret is generated; it is hidden in this result unless revealSecret is true, and stays available later via webhook_endpoint_retrieve. The app verifies deliveries with this secret (SDK: validateEvent).',
41
+ annotations: { destructiveHint: false, idempotentHint: false },
42
+ inputSchema: WebhookEndpointCreate.shape,
43
+ }, async (input) => {
44
+ const { revealSecret, ...body } = input;
45
+ const result = await http.request({
46
+ method: 'POST',
47
+ path: '/webhook/endpoints/',
48
+ body,
49
+ auth: 'server',
50
+ });
51
+ return resultToContent(secretAware(result, revealSecret));
52
+ });
53
+ server.registerTool('webhook_endpoint_retrieve', {
54
+ title: 'Retrieve webhook endpoint',
55
+ description: 'Fetch one webhook endpoint by ID. The signing secret is hidden unless revealSecret is true.',
56
+ annotations: { readOnlyHint: true },
57
+ inputSchema: WebhookEndpointRetrieve.shape,
58
+ }, async (input) => {
59
+ const result = await http.request({
60
+ method: 'GET',
61
+ path: `/webhook/endpoints/${encodeURIComponent(input.endpointId)}/`,
62
+ auth: 'server',
63
+ });
64
+ return resultToContent(secretAware(result, input.revealSecret));
65
+ });
66
+ server.registerTool('webhook_endpoint_update', {
67
+ title: 'Update webhook endpoint',
68
+ description: 'Change a webhook endpoint’s URL, subscribed events, or enabled state. Only the fields you pass change. The signing secret is hidden unless revealSecret is true.',
69
+ annotations: { destructiveHint: false, idempotentHint: true },
70
+ inputSchema: WebhookEndpointUpdate.shape,
71
+ }, async (input) => {
72
+ const { endpointId, revealSecret, ...body } = input;
73
+ const result = await http.request({
74
+ method: 'PATCH',
75
+ path: `/webhook/endpoints/${encodeURIComponent(endpointId)}/`,
76
+ body,
77
+ auth: 'server',
78
+ });
79
+ return resultToContent(secretAware(result, revealSecret));
80
+ });
81
+ server.registerTool('webhook_endpoint_delete', {
82
+ title: 'Delete webhook endpoint',
83
+ description: 'Permanently delete a webhook endpoint. It stops receiving deliveries immediately. Confirm with the user first.',
84
+ annotations: { destructiveHint: true, idempotentHint: true },
85
+ inputSchema: WebhookEndpointDelete.shape,
86
+ }, async (input) => {
87
+ const result = await http.request({
88
+ method: 'DELETE',
89
+ path: `/webhook/endpoints/${encodeURIComponent(input.endpointId)}/`,
90
+ auth: 'server',
91
+ });
92
+ return resultToContent(result);
93
+ });
94
+ server.registerTool('webhook_log_list', {
95
+ title: 'List webhook deliveries',
96
+ description: 'List webhook delivery attempts (including retries), newest first, with event type, status code and success. Covers the last 30 days at most; `startDate` and `endDate` (YYYY-MM-DD) narrow the window. Use it to debug why an app is not receiving events.',
97
+ annotations: { readOnlyHint: true },
98
+ inputSchema: ListWebhookLogs.shape,
99
+ }, async (input) => {
100
+ const result = await http.request({
101
+ method: 'GET',
102
+ path: '/webhook/logs/',
103
+ auth: 'server',
104
+ query: {
105
+ start_date: input.startDate,
106
+ end_date: input.endDate,
107
+ page: input.page,
108
+ page_size: input.pageSize,
109
+ },
110
+ });
111
+ return resultToContent(result);
112
+ });
113
+ }
114
+ //# sourceMappingURL=webhooks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/tools/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,CAAC,MAAM,aAAa,GACxB,2GAA2G,CAAC;AAE9G;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC1D,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;YACtC,GAAG;YACH,GAAG,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;SAC7F,CAAC,CACH,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,MAAuB,EAAE,YAAiC;IAC7E,OAAO,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC9F,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAiB,EAAE,IAAsB;IAC5E,MAAM,CAAC,YAAY,CACjB,uBAAuB,EACvB;QACE,KAAK,EAAE,wBAAwB;QAC/B,WAAW,EACT,oNAAoN;QACtN,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;QACnC,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE;SACvD,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAClE,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,yBAAyB,EACzB;QACE,KAAK,EAAE,yBAAyB;QAChC,WAAW,EACT,kVAAkV;QACpV,WAAW,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE;QAC9D,WAAW,EAAE,qBAAqB,CAAC,KAAK;KACzC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qBAAqB;YAC3B,IAAI;YACJ,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAC5D,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,2BAA2B,EAC3B;QACE,KAAK,EAAE,2BAA2B;QAClC,WAAW,EACT,6FAA6F;QAC/F,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;QACnC,WAAW,EAAE,uBAAuB,CAAC,KAAK;KAC3C,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,sBAAsB,kBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG;YACnE,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAClE,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,yBAAyB,EACzB;QACE,KAAK,EAAE,yBAAyB;QAChC,WAAW,EACT,kKAAkK;QACpK,WAAW,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE;QAC7D,WAAW,EAAE,qBAAqB,CAAC,KAAK;KACzC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,sBAAsB,kBAAkB,CAAC,UAAU,CAAC,GAAG;YAC7D,IAAI;YACJ,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAC5D,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,yBAAyB,EACzB;QACE,KAAK,EAAE,yBAAyB;QAChC,WAAW,EACT,gHAAgH;QAClH,WAAW,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE;QAC5D,WAAW,EAAE,qBAAqB,CAAC,KAAK;KACzC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,sBAAsB,kBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG;YACnE,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,kBAAkB,EAClB;QACE,KAAK,EAAE,yBAAyB;QAChC,WAAW,EACT,4PAA4P;QAC9P,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;QACnC,WAAW,EAAE,eAAe,CAAC,KAAK;KACnC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACL,UAAU,EAAE,KAAK,CAAC,SAAS;gBAC3B,QAAQ,EAAE,KAAK,CAAC,OAAO;gBACvB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,SAAS,EAAE,KAAK,CAAC,QAAQ;aAC1B;SACF,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC,CACF,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kelviq/mcp-server",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "description": "Model Context Protocol server for Kelviq — typed tools for the Kelviq API plus searchable documentation resources.",
5
5
  "license": "MIT",
6
6
  "author": "Kelviq <hi@kelviq.com>",