@opencx/mcp 1.7.0 → 1.8.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/dist/api-client.spec.d.ts +2 -0
- package/dist/api-client.spec.d.ts.map +1 -0
- package/dist/api-client.spec.js +139 -0
- package/dist/api-client.spec.js.map +1 -0
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +2 -0
- package/dist/server.js.map +1 -1
- package/dist/server.spec.d.ts +2 -0
- package/dist/server.spec.d.ts.map +1 -0
- package/dist/server.spec.js +109 -0
- package/dist/server.spec.js.map +1 -0
- package/dist/tools/sla-analytics.d.ts +4 -0
- package/dist/tools/sla-analytics.d.ts.map +1 -0
- package/dist/tools/sla-analytics.js +80 -0
- package/dist/tools/sla-analytics.js.map +1 -0
- package/package.json +5 -3
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.spec.d.ts","sourceRoot":"","sources":["../src/api-client.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
2
|
+
import { ApiError, safePath, OpenCXClient } from './api-client.js';
|
|
3
|
+
describe('ApiError', () => {
|
|
4
|
+
it('stores status, statusText, and body', () => {
|
|
5
|
+
const err = new ApiError(404, 'Not Found', '{"error":"missing"}');
|
|
6
|
+
expect(err.status).toBe(404);
|
|
7
|
+
expect(err.statusText).toBe('Not Found');
|
|
8
|
+
expect(err.body).toBe('{"error":"missing"}');
|
|
9
|
+
expect(err.name).toBe('ApiError');
|
|
10
|
+
expect(err.message).toContain('404');
|
|
11
|
+
});
|
|
12
|
+
});
|
|
13
|
+
describe('safePath', () => {
|
|
14
|
+
it('allows a normal id', () => {
|
|
15
|
+
expect(safePath('abc-123')).toBe('abc-123');
|
|
16
|
+
});
|
|
17
|
+
it('allows a uuid', () => {
|
|
18
|
+
const uuid = '550e8400-e29b-41d4-a716-446655440000';
|
|
19
|
+
expect(safePath(uuid)).toBe(uuid);
|
|
20
|
+
});
|
|
21
|
+
it('rejects empty string', () => {
|
|
22
|
+
expect(() => safePath('')).toThrow('Invalid path parameter');
|
|
23
|
+
});
|
|
24
|
+
it('rejects forward slashes', () => {
|
|
25
|
+
expect(() => safePath('../../etc/passwd')).toThrow('Invalid path parameter');
|
|
26
|
+
});
|
|
27
|
+
it('rejects backslashes', () => {
|
|
28
|
+
expect(() => safePath('foo\\bar')).toThrow('Invalid path parameter');
|
|
29
|
+
});
|
|
30
|
+
it('rejects bare ..', () => {
|
|
31
|
+
expect(() => safePath('..')).toThrow('Invalid path parameter');
|
|
32
|
+
});
|
|
33
|
+
it('rejects encoded slashes', () => {
|
|
34
|
+
expect(() => safePath('..%2F..%2Fetc')).toThrow('Invalid path parameter');
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
describe('OpenCXClient', () => {
|
|
38
|
+
let fetchSpy;
|
|
39
|
+
beforeEach(() => {
|
|
40
|
+
fetchSpy = vi.fn();
|
|
41
|
+
vi.stubGlobal('fetch', fetchSpy);
|
|
42
|
+
});
|
|
43
|
+
afterEach(() => {
|
|
44
|
+
vi.restoreAllMocks();
|
|
45
|
+
});
|
|
46
|
+
function mockResponse(body, status = 200) {
|
|
47
|
+
fetchSpy.mockResolvedValueOnce({
|
|
48
|
+
ok: status >= 200 && status < 300,
|
|
49
|
+
status,
|
|
50
|
+
statusText: status === 200 ? 'OK' : 'Bad Request',
|
|
51
|
+
text: () => Promise.resolve(JSON.stringify(body)),
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
it('strips trailing slash from baseUrl', () => {
|
|
55
|
+
const client = new OpenCXClient('key-123', 'https://api.example.com/');
|
|
56
|
+
mockResponse({ ok: true });
|
|
57
|
+
void client.get('/test');
|
|
58
|
+
expect(fetchSpy).toHaveBeenCalledWith('https://api.example.com/test', expect.objectContaining({ method: 'GET' }));
|
|
59
|
+
});
|
|
60
|
+
it('sets Authorization header with Bearer token', () => {
|
|
61
|
+
const client = new OpenCXClient('my-api-key', 'https://api.example.com');
|
|
62
|
+
mockResponse({ ok: true });
|
|
63
|
+
void client.get('/test');
|
|
64
|
+
expect(fetchSpy).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({
|
|
65
|
+
headers: expect.objectContaining({
|
|
66
|
+
Authorization: 'Bearer my-api-key',
|
|
67
|
+
'Content-Type': 'application/json',
|
|
68
|
+
}),
|
|
69
|
+
}));
|
|
70
|
+
});
|
|
71
|
+
it('GET appends query params', async () => {
|
|
72
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
73
|
+
mockResponse({ items: [] });
|
|
74
|
+
await client.get('/contacts/', { cursor: 'abc', empty: undefined });
|
|
75
|
+
const url = fetchSpy.mock.calls[0][0];
|
|
76
|
+
expect(url).toBe('https://api.example.com/contacts/?cursor=abc');
|
|
77
|
+
});
|
|
78
|
+
it('POST sends JSON body', async () => {
|
|
79
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
80
|
+
mockResponse({ id: '1' });
|
|
81
|
+
await client.post('/contacts/', { name: 'Alice' });
|
|
82
|
+
const opts = fetchSpy.mock.calls[0][1];
|
|
83
|
+
expect(opts.method).toBe('POST');
|
|
84
|
+
expect(opts.body).toBe(JSON.stringify({ name: 'Alice' }));
|
|
85
|
+
});
|
|
86
|
+
it('PATCH sends JSON body', async () => {
|
|
87
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
88
|
+
mockResponse({ id: '1' });
|
|
89
|
+
await client.patch('/contacts/1', { name: 'Bob' });
|
|
90
|
+
const opts = fetchSpy.mock.calls[0][1];
|
|
91
|
+
expect(opts.method).toBe('PATCH');
|
|
92
|
+
});
|
|
93
|
+
it('PUT sends JSON body', async () => {
|
|
94
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
95
|
+
mockResponse({ ok: true });
|
|
96
|
+
await client.put('/settings', { value: true });
|
|
97
|
+
const opts = fetchSpy.mock.calls[0][1];
|
|
98
|
+
expect(opts.method).toBe('PUT');
|
|
99
|
+
});
|
|
100
|
+
it('DELETE sends no body', async () => {
|
|
101
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
102
|
+
mockResponse({});
|
|
103
|
+
await client.delete('/contacts/1');
|
|
104
|
+
const opts = fetchSpy.mock.calls[0][1];
|
|
105
|
+
expect(opts.method).toBe('DELETE');
|
|
106
|
+
expect(opts.body).toBeUndefined();
|
|
107
|
+
});
|
|
108
|
+
it('throws ApiError on non-ok response', async () => {
|
|
109
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
110
|
+
fetchSpy.mockResolvedValueOnce({
|
|
111
|
+
ok: false,
|
|
112
|
+
status: 401,
|
|
113
|
+
statusText: 'Unauthorized',
|
|
114
|
+
text: () => Promise.resolve('invalid key'),
|
|
115
|
+
});
|
|
116
|
+
await expect(client.get('/org/')).rejects.toThrow(ApiError);
|
|
117
|
+
await expect((async () => {
|
|
118
|
+
fetchSpy.mockResolvedValueOnce({
|
|
119
|
+
ok: false,
|
|
120
|
+
status: 401,
|
|
121
|
+
statusText: 'Unauthorized',
|
|
122
|
+
text: () => Promise.resolve('invalid key'),
|
|
123
|
+
});
|
|
124
|
+
return client.get('/org/');
|
|
125
|
+
})()).rejects.toMatchObject({ status: 401, body: 'invalid key' });
|
|
126
|
+
});
|
|
127
|
+
it('returns undefined for empty response body', async () => {
|
|
128
|
+
const client = new OpenCXClient('key', 'https://api.example.com');
|
|
129
|
+
fetchSpy.mockResolvedValueOnce({
|
|
130
|
+
ok: true,
|
|
131
|
+
status: 204,
|
|
132
|
+
statusText: 'No Content',
|
|
133
|
+
text: () => Promise.resolve(''),
|
|
134
|
+
});
|
|
135
|
+
const result = await client.delete('/contacts/1');
|
|
136
|
+
expect(result).toBeUndefined();
|
|
137
|
+
});
|
|
138
|
+
});
|
|
139
|
+
//# sourceMappingURL=api-client.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.spec.js","sourceRoot":"","sources":["../src/api-client.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEnE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,qBAAqB,CAAC,CAAC;QAClE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;QACvB,MAAM,IAAI,GAAG,sCAAsC,CAAC;QACpD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;QACzB,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,QAAkC,CAAC;IAEvC,UAAU,CAAC,GAAG,EAAE;QACd,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACnB,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,SAAS,YAAY,CAAC,IAAa,EAAE,MAAM,GAAG,GAAG;QAC/C,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,GAAG;YACjC,MAAM;YACN,UAAU,EAAE,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa;YACjD,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAC;QACvE,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3B,KAAK,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEzB,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,8BAA8B,EAC9B,MAAM,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC3C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;QACzE,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3B,KAAK,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEzB,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,QAAQ,EAAE,EACjB,MAAM,CAAC,gBAAgB,CAAC;YACtB,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;gBAC/B,aAAa,EAAE,mBAAmB;gBAClC,cAAc,EAAE,kBAAkB;aACnC,CAAC;SACH,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAE5B,MAAM,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAEpE,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QAChD,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,YAAY,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAE1B,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAEnD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAgB,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,YAAY,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAE1B,MAAM,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAEnD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAgB,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3B,MAAM,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAgB,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,YAAY,CAAC,EAAE,CAAC,CAAC;QAEjB,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEnC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAgB,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,EAAE,EAAE,KAAK;YACT,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,cAAc;YAC1B,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;SAC3C,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,MAAM,CACV,CAAC,KAAK,IAAI,EAAE;YACV,QAAQ,CAAC,qBAAqB,CAAC;gBAC7B,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,GAAG;gBACX,UAAU,EAAE,cAAc;gBAC1B,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;aAC3C,CAAC,CAAC;YACH,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC,CAAC,EAAE,CACL,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAClE,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,YAAY;YACxB,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;SAChC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/server.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAwBpE,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CA+BvE"}
|
package/dist/server.js
CHANGED
|
@@ -19,6 +19,7 @@ import { registerTagTools } from './tools/tags.js';
|
|
|
19
19
|
import { registerCsatTools } from './tools/csat.js';
|
|
20
20
|
import { registerWhatsAppTools } from './tools/whatsapp.js';
|
|
21
21
|
import { registerHandoffAnalyticsTools } from './tools/handoff-analytics.js';
|
|
22
|
+
import { registerSlaAnalyticsTools } from './tools/sla-analytics.js';
|
|
22
23
|
import { registerWorkflowTools } from './tools/workflows.js';
|
|
23
24
|
export function createServer(apiKey, baseUrl) {
|
|
24
25
|
const server = new McpServer({
|
|
@@ -45,6 +46,7 @@ export function createServer(apiKey, baseUrl) {
|
|
|
45
46
|
registerCsatTools(server, client);
|
|
46
47
|
registerWhatsAppTools(server, client);
|
|
47
48
|
registerHandoffAnalyticsTools(server, client);
|
|
49
|
+
registerSlaAnalyticsTools(server, client);
|
|
48
50
|
registerWorkflowTools(server, client);
|
|
49
51
|
return server;
|
|
50
52
|
}
|
package/dist/server.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,OAAe;IAC1D,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjD,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,6BAA6B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,OAAe;IAC1D,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjD,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,6BAA6B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.spec.d.ts","sourceRoot":"","sources":["../src/server.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
2
|
+
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
|
|
3
|
+
import { InMemoryTransport } from '@modelcontextprotocol/sdk/inMemory.js';
|
|
4
|
+
import { createServer } from './server.js';
|
|
5
|
+
const EXPECTED_TOOL_PREFIXES = [
|
|
6
|
+
'list_contacts',
|
|
7
|
+
'create_contact',
|
|
8
|
+
'get_organization',
|
|
9
|
+
'search',
|
|
10
|
+
'list_sessions',
|
|
11
|
+
'list_training_scenarios',
|
|
12
|
+
'list_actions',
|
|
13
|
+
'list_teams',
|
|
14
|
+
];
|
|
15
|
+
describe('MCP Server', () => {
|
|
16
|
+
let client;
|
|
17
|
+
let cleanup;
|
|
18
|
+
let fetchSpy;
|
|
19
|
+
beforeEach(async () => {
|
|
20
|
+
fetchSpy = vi.fn();
|
|
21
|
+
vi.stubGlobal('fetch', fetchSpy);
|
|
22
|
+
const server = createServer('test-api-key', 'https://api.test.com');
|
|
23
|
+
const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
|
|
24
|
+
await server.connect(serverTransport);
|
|
25
|
+
client = new Client({ name: 'test-client', version: '1.0.0' });
|
|
26
|
+
await client.connect(clientTransport);
|
|
27
|
+
cleanup = async () => {
|
|
28
|
+
await client.close();
|
|
29
|
+
await server.close();
|
|
30
|
+
};
|
|
31
|
+
});
|
|
32
|
+
afterEach(async () => {
|
|
33
|
+
await cleanup();
|
|
34
|
+
vi.restoreAllMocks();
|
|
35
|
+
});
|
|
36
|
+
it('completes the MCP handshake', () => {
|
|
37
|
+
const version = client.getServerVersion();
|
|
38
|
+
expect(version).toBeDefined();
|
|
39
|
+
expect(version?.name).toBe('OpenCX');
|
|
40
|
+
});
|
|
41
|
+
it('registers tools that are discoverable via listTools', async () => {
|
|
42
|
+
const { tools } = await client.listTools();
|
|
43
|
+
expect(tools.length).toBeGreaterThan(0);
|
|
44
|
+
const toolNames = tools.map((t) => t.name);
|
|
45
|
+
for (const prefix of EXPECTED_TOOL_PREFIXES) {
|
|
46
|
+
expect(toolNames).toContain(prefix);
|
|
47
|
+
}
|
|
48
|
+
});
|
|
49
|
+
it('every tool has a description and input schema', async () => {
|
|
50
|
+
const { tools } = await client.listTools();
|
|
51
|
+
for (const tool of tools) {
|
|
52
|
+
expect(tool.description, `${tool.name} has no description`).toBeTruthy();
|
|
53
|
+
expect(tool.inputSchema, `${tool.name} has no input schema`).toBeDefined();
|
|
54
|
+
expect(tool.inputSchema.type).toBe('object');
|
|
55
|
+
}
|
|
56
|
+
});
|
|
57
|
+
it('calls a tool that proxies to the API client', async () => {
|
|
58
|
+
fetchSpy.mockResolvedValueOnce({
|
|
59
|
+
ok: true,
|
|
60
|
+
status: 200,
|
|
61
|
+
statusText: 'OK',
|
|
62
|
+
text: () => Promise.resolve(JSON.stringify({ name: 'Test Org' })),
|
|
63
|
+
});
|
|
64
|
+
const result = await client.callTool({
|
|
65
|
+
name: 'get_organization',
|
|
66
|
+
arguments: {},
|
|
67
|
+
});
|
|
68
|
+
expect(fetchSpy).toHaveBeenCalledOnce();
|
|
69
|
+
const [url, opts] = fetchSpy.mock.calls[0];
|
|
70
|
+
expect(url).toBe('https://api.test.com/org/');
|
|
71
|
+
expect(opts.headers['Authorization']).toBe('Bearer test-api-key');
|
|
72
|
+
expect(result.content).toBeDefined();
|
|
73
|
+
const content = result.content;
|
|
74
|
+
expect(content[0].type).toBe('text');
|
|
75
|
+
expect(JSON.parse(content[0].text)).toEqual({ name: 'Test Org' });
|
|
76
|
+
});
|
|
77
|
+
it('returns isError when the API returns non-ok', async () => {
|
|
78
|
+
fetchSpy.mockResolvedValueOnce({
|
|
79
|
+
ok: false,
|
|
80
|
+
status: 500,
|
|
81
|
+
statusText: 'Internal Server Error',
|
|
82
|
+
text: () => Promise.resolve('boom'),
|
|
83
|
+
});
|
|
84
|
+
const result = await client.callTool({
|
|
85
|
+
name: 'get_organization',
|
|
86
|
+
arguments: {},
|
|
87
|
+
});
|
|
88
|
+
expect(result.isError).toBe(true);
|
|
89
|
+
const content = result.content;
|
|
90
|
+
expect(content[0].text).toContain('500');
|
|
91
|
+
});
|
|
92
|
+
it('passes arguments through to the API', async () => {
|
|
93
|
+
fetchSpy.mockResolvedValueOnce({
|
|
94
|
+
ok: true,
|
|
95
|
+
status: 200,
|
|
96
|
+
statusText: 'OK',
|
|
97
|
+
text: () => Promise.resolve(JSON.stringify({ id: '1', name: 'Updated Org' })),
|
|
98
|
+
});
|
|
99
|
+
await client.callTool({
|
|
100
|
+
name: 'update_organization',
|
|
101
|
+
arguments: { name: 'New Name' },
|
|
102
|
+
});
|
|
103
|
+
expect(fetchSpy).toHaveBeenCalledOnce();
|
|
104
|
+
const [, opts] = fetchSpy.mock.calls[0];
|
|
105
|
+
expect(opts.method).toBe('PATCH');
|
|
106
|
+
expect(JSON.parse(opts.body)).toEqual({ name: 'New Name' });
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
//# sourceMappingURL=server.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.spec.js","sourceRoot":"","sources":["../src/server.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,sBAAsB,GAAG;IAC7B,eAAe;IACf,gBAAgB;IAChB,kBAAkB;IAClB,QAAQ;IACR,eAAe;IACf,yBAAyB;IACzB,cAAc;IACd,YAAY;CACb,CAAC;AAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAI,MAAc,CAAC;IACnB,IAAI,OAA4B,CAAC;IACjC,IAAI,QAAkC,CAAC;IAEvC,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACnB,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEjC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;QACpE,MAAM,CAAC,eAAe,EAAE,eAAe,CAAC,GACtC,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;QAEvC,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEtC,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEtC,OAAO,GAAG,KAAK,IAAI,EAAE;YACnB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;YACrB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,OAAO,EAAE,CAAC;QAChB,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAExC,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,KAAK,MAAM,MAAM,IAAI,sBAAsB,EAAE,CAAC;YAC5C,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;QAE3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,qBAAqB,CAAC,CAAC,UAAU,EAAE,CAAC;YACzE,MAAM,CACJ,IAAI,CAAC,WAAW,EAChB,GAAG,IAAI,CAAC,IAAI,sBAAsB,CACnC,CAAC,WAAW,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;SAClE,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC;YACnC,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QAEH,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,EAAE,CAAC;QACxC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAA0B,CAAC;QACpE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC9C,MAAM,CACH,IAAI,CAAC,OAAkC,CAAC,eAAe,CAAC,CAC1D,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE9B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAgD,CAAC;QACxE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,EAAE,EAAE,KAAK;YACT,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,uBAAuB;YACnC,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;SACpC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC;YACnC,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAgD,CAAC;QACxE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,GAAG,EAAE,CACT,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;SACpE,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,QAAQ,CAAC;YACpB,IAAI,EAAE,qBAAqB;YAC3B,SAAS,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;SAChC,CAAC,CAAC;QAEH,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,EAAE,CAAC;QACxC,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAA0B,CAAC;QACjE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAc,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sla-analytics.d.ts","sourceRoot":"","sources":["../../src/tools/sla-analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAEpE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAkBhD,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,QAqFhF"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
const slaFilters = {
|
|
3
|
+
from: z.string().describe('Start date in ISO 8601 format (e.g. "2025-01-01")'),
|
|
4
|
+
to: z.string().describe('End date in ISO 8601 format (e.g. "2025-01-31")'),
|
|
5
|
+
timezone: z
|
|
6
|
+
.string()
|
|
7
|
+
.optional()
|
|
8
|
+
.describe('IANA timezone for date boundaries (e.g. "America/New_York"). Defaults to UTC.'),
|
|
9
|
+
policy_id: z.string().optional().describe('Filter by SLA policy ID'),
|
|
10
|
+
team_id: z.string().optional().describe('Filter by team ID'),
|
|
11
|
+
channel: z
|
|
12
|
+
.string()
|
|
13
|
+
.optional()
|
|
14
|
+
.describe('Filter by channel (e.g. "web", "whatsapp", "email", "phone")'),
|
|
15
|
+
agent_id: z.string().optional().describe('Filter by agent ID'),
|
|
16
|
+
};
|
|
17
|
+
export function registerSlaAnalyticsTools(server, client) {
|
|
18
|
+
server.tool('get_sla_analytics_overview', 'Get SLA analytics overview including compliance rates (overall, first reply, next reply, resolution), coverage rate, and response/resolution time percentiles (p50, p90, p95) for a date range.', slaFilters, async (params) => {
|
|
19
|
+
const data = await client.get('/sla/analytics', {
|
|
20
|
+
from: params.from,
|
|
21
|
+
to: params.to,
|
|
22
|
+
timezone: params.timezone,
|
|
23
|
+
policy_id: params.policy_id,
|
|
24
|
+
team_id: params.team_id,
|
|
25
|
+
channel: params.channel,
|
|
26
|
+
agent_id: params.agent_id,
|
|
27
|
+
});
|
|
28
|
+
return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
|
|
29
|
+
});
|
|
30
|
+
server.tool('get_sla_analytics_breakdown', 'Get SLA compliance rates grouped by policy, team, agent, or channel. Each group includes session count, compliance metrics, and time percentiles.', {
|
|
31
|
+
...slaFilters,
|
|
32
|
+
group_by: z
|
|
33
|
+
.enum(['policy', 'team', 'agent', 'channel'])
|
|
34
|
+
.describe('Dimension to group results by'),
|
|
35
|
+
}, async (params) => {
|
|
36
|
+
const data = await client.get('/sla/analytics/breakdown', {
|
|
37
|
+
from: params.from,
|
|
38
|
+
to: params.to,
|
|
39
|
+
timezone: params.timezone,
|
|
40
|
+
policy_id: params.policy_id,
|
|
41
|
+
team_id: params.team_id,
|
|
42
|
+
channel: params.channel,
|
|
43
|
+
agent_id: params.agent_id,
|
|
44
|
+
group_by: params.group_by,
|
|
45
|
+
});
|
|
46
|
+
return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
|
|
47
|
+
});
|
|
48
|
+
server.tool('get_sla_analytics_trend', 'Get SLA compliance rates over time, grouped by day or week. Returns a time series of compliance metrics and percentiles for each period.', {
|
|
49
|
+
...slaFilters,
|
|
50
|
+
granularity: z
|
|
51
|
+
.enum(['day', 'week'])
|
|
52
|
+
.optional()
|
|
53
|
+
.describe('Time granularity for the trend data. Defaults to "day".'),
|
|
54
|
+
}, async (params) => {
|
|
55
|
+
const data = await client.get('/sla/analytics/trend', {
|
|
56
|
+
from: params.from,
|
|
57
|
+
to: params.to,
|
|
58
|
+
timezone: params.timezone,
|
|
59
|
+
policy_id: params.policy_id,
|
|
60
|
+
team_id: params.team_id,
|
|
61
|
+
channel: params.channel,
|
|
62
|
+
agent_id: params.agent_id,
|
|
63
|
+
granularity: params.granularity,
|
|
64
|
+
});
|
|
65
|
+
return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
|
|
66
|
+
});
|
|
67
|
+
server.tool('get_sla_breach_heatmap', 'Get a heatmap of SLA breaches by hour of day (0-23) and day of week (0=Sunday to 6=Saturday). Useful for identifying patterns in when SLA breaches occur.', slaFilters, async (params) => {
|
|
68
|
+
const data = await client.get('/sla/analytics/breach-heatmap', {
|
|
69
|
+
from: params.from,
|
|
70
|
+
to: params.to,
|
|
71
|
+
timezone: params.timezone,
|
|
72
|
+
policy_id: params.policy_id,
|
|
73
|
+
team_id: params.team_id,
|
|
74
|
+
channel: params.channel,
|
|
75
|
+
agent_id: params.agent_id,
|
|
76
|
+
});
|
|
77
|
+
return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
//# sourceMappingURL=sla-analytics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sla-analytics.js","sourceRoot":"","sources":["../../src/tools/sla-analytics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mDAAmD,CAAC;IAC9E,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iDAAiD,CAAC;IAC1E,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,+EAA+E,CAAC;IAC5F,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACpE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC5D,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAC/D,CAAC;AAEF,MAAM,UAAU,yBAAyB,CAAC,MAAiB,EAAE,MAAoB;IAC/E,MAAM,CAAC,IAAI,CACT,4BAA4B,EAC5B,iMAAiM,EACjM,UAAU,EACV,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAC9C,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9E,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,IAAI,CACT,6BAA6B,EAC7B,mJAAmJ,EACnJ;QACE,GAAG,UAAU;QACb,QAAQ,EAAE,CAAC;aACR,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;aAC5C,QAAQ,CAAC,+BAA+B,CAAC;KAC7C,EACD,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE;YACxD,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9E,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,IAAI,CACT,yBAAyB,EACzB,0IAA0I,EAC1I;QACE,GAAG,UAAU;QACb,WAAW,EAAE,CAAC;aACX,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;aACrB,QAAQ,EAAE;aACV,QAAQ,CAAC,yDAAyD,CAAC;KACvE,EACD,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACpD,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9E,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,IAAI,CACT,wBAAwB,EACxB,2JAA2J,EAC3J,UAAU,EACV,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE;YAC7D,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9E,CAAC,CACF,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opencx/mcp",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.8.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "MCP server for OpenCX — manage contacts, sessions, training, and more from Claude Desktop, Cursor, or any MCP client.",
|
|
6
6
|
"type": "module",
|
|
@@ -31,11 +31,13 @@
|
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"@types/node": "^25.3.0",
|
|
34
|
-
"typescript": "^5.9.3"
|
|
34
|
+
"typescript": "^5.9.3",
|
|
35
|
+
"vitest": "^4.0.17"
|
|
35
36
|
},
|
|
36
37
|
"scripts": {
|
|
37
38
|
"build": "tsc",
|
|
38
39
|
"dev": "tsc --watch",
|
|
39
|
-
"start": "node dist/index.js"
|
|
40
|
+
"start": "node dist/index.js",
|
|
41
|
+
"test": "vitest run"
|
|
40
42
|
}
|
|
41
43
|
}
|