@listo-ai/mcp-observability 0.4.1 → 0.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 +23 -1
- package/dist/index.d.ts +29 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +90 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,6 +14,7 @@ This SDK provides comprehensive observability for [Model Context Protocol (MCP)]
|
|
|
14
14
|
- **Centralized analytics** -- Send telemetry data to a remote endpoint in production
|
|
15
15
|
- **Automatic tracking** -- HTTP requests via Express middleware, MCP tool invocations via handler wrapper
|
|
16
16
|
- **Payload sanitization** -- Built-in redaction of sensitive keys (`password`, `token`, `apiKey`, `secret`, `authorization`)
|
|
17
|
+
- **Platform detection** -- Automatically identify the AI platform (Claude, ChatGPT, or other) from request headers and metadata
|
|
17
18
|
- **Sampling** -- Configurable sampling rates with guaranteed capture of errors and session events
|
|
18
19
|
- **Zero runtime dependencies** -- Only relies on Node.js built-ins (`crypto`, `http`)
|
|
19
20
|
|
|
@@ -24,6 +25,7 @@ This SDK provides comprehensive observability for [Model Context Protocol (MCP)]
|
|
|
24
25
|
- [Browser Client](#browser-client)
|
|
25
26
|
- [How It Works](#how-it-works)
|
|
26
27
|
- [API Reference](#api-reference)
|
|
28
|
+
- [Platform Detection](#detectplatformhints)
|
|
27
29
|
- [Integration Guide](#integration-guide)
|
|
28
30
|
- [Event Types](#event-types)
|
|
29
31
|
- [Environment Variables](#environment-variables)
|
|
@@ -270,15 +272,33 @@ observability.recordUiEvent({
|
|
|
270
272
|
});
|
|
271
273
|
```
|
|
272
274
|
|
|
275
|
+
### `detectPlatform(hints?)`
|
|
276
|
+
|
|
277
|
+
Identify the AI platform calling your MCP server. Returns `'claude'`, `'chatgpt'`, or `'other'`.
|
|
278
|
+
|
|
279
|
+
```typescript
|
|
280
|
+
import { detectPlatform } from '@listo-ai/mcp-observability';
|
|
281
|
+
|
|
282
|
+
const platform = detectPlatform({
|
|
283
|
+
headers: request.headers, // HTTP headers (user-agent, x-openai-*, x-anthropic-*)
|
|
284
|
+
meta: mcpRequest.params?._meta, // _meta key prefixes (openai/*, anthropic/*)
|
|
285
|
+
clientInfo: mcpRequest.params?.clientInfo // clientInfo.name fallback
|
|
286
|
+
});
|
|
287
|
+
// → 'claude', 'chatgpt', or 'other'
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
Detection checks three signal tiers in order (first match wins): HTTP headers, `_meta` key prefixes, then `clientInfo.name`. See [Platform Detection docs](./docs/platform-detection.md) for details.
|
|
291
|
+
|
|
273
292
|
### `observability.recordSession(event)`
|
|
274
293
|
|
|
275
|
-
Record MCP session lifecycle events.
|
|
294
|
+
Record MCP session lifecycle events. Pass `platform` from `detectPlatform()` on session open to attribute the session to an AI platform.
|
|
276
295
|
|
|
277
296
|
```typescript
|
|
278
297
|
observability.recordSession({
|
|
279
298
|
type: 'mcp_session',
|
|
280
299
|
action: 'open',
|
|
281
300
|
sessionId: 'session-123',
|
|
301
|
+
platform: detectPlatform({ headers: request.headers }),
|
|
282
302
|
});
|
|
283
303
|
```
|
|
284
304
|
|
|
@@ -412,6 +432,7 @@ Recorded via `recordSession()`. Always captured regardless of sample rate.
|
|
|
412
432
|
type: 'mcp_session',
|
|
413
433
|
action: 'open', // or 'close'
|
|
414
434
|
sessionId: 'session-123',
|
|
435
|
+
platform: 'claude', // 'claude', 'chatgpt', or 'other'
|
|
415
436
|
}
|
|
416
437
|
```
|
|
417
438
|
|
|
@@ -506,6 +527,7 @@ Full Amplitude-style documentation is available in the [`docs/`](./docs/) direct
|
|
|
506
527
|
| [Track HTTP](./docs/track-http.md) | `expressTelemetry()` + `trackHttpRequest()` |
|
|
507
528
|
| [Wrap MCP Handlers](./docs/wrap-mcp-handlers.md) | `wrapMcpHandler()`, context fields |
|
|
508
529
|
| [Sessions](./docs/sessions.md) | `recordSession()`, always-capture behavior |
|
|
530
|
+
| [Platform Detection](./docs/platform-detection.md) | `detectPlatform()`, header/meta/clientInfo signals |
|
|
509
531
|
| [Business Events](./docs/business-events.md) | `recordBusinessEvent()` |
|
|
510
532
|
| [UI Events](./docs/ui-events.md) | `recordUiEvent()` + POST endpoint |
|
|
511
533
|
| [Browser Client](./docs/client.md) | `TelemetryClient` for browser apps |
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,17 @@
|
|
|
1
1
|
import type { IncomingMessage, ServerResponse } from 'node:http';
|
|
2
2
|
export type EventStatus = 'ok' | 'error';
|
|
3
3
|
export type EventCategory = 'conversion' | 'engagement' | 'impression' | 'navigation' | 'system';
|
|
4
|
+
export type KnownPlatform = 'claude' | 'chatgpt' | 'other';
|
|
5
|
+
export type Platform = KnownPlatform;
|
|
6
|
+
export type McpClientInfo = {
|
|
7
|
+
name: string;
|
|
8
|
+
version?: string;
|
|
9
|
+
};
|
|
10
|
+
export type PlatformHints = {
|
|
11
|
+
headers?: Record<string, string | string[] | undefined>;
|
|
12
|
+
meta?: Record<string, unknown>;
|
|
13
|
+
clientInfo?: McpClientInfo;
|
|
14
|
+
};
|
|
4
15
|
export type HttpRequestEvent = {
|
|
5
16
|
type: 'http_request';
|
|
6
17
|
timestamp: number;
|
|
@@ -33,6 +44,7 @@ export type McpRequestEvent = {
|
|
|
33
44
|
latencyMs: number;
|
|
34
45
|
tenantId?: string;
|
|
35
46
|
sessionId?: string;
|
|
47
|
+
platform?: Platform;
|
|
36
48
|
locale?: string;
|
|
37
49
|
userAgent?: string;
|
|
38
50
|
argsHash?: string;
|
|
@@ -55,6 +67,7 @@ export type McpSessionEvent = {
|
|
|
55
67
|
environment?: string;
|
|
56
68
|
action: 'open' | 'close';
|
|
57
69
|
sessionId: string;
|
|
70
|
+
platform?: Platform;
|
|
58
71
|
};
|
|
59
72
|
export type BusinessEvent = {
|
|
60
73
|
type: 'business_event';
|
|
@@ -95,6 +108,7 @@ export type ObservabilityOptions = {
|
|
|
95
108
|
serviceName: string;
|
|
96
109
|
serviceVersion?: string;
|
|
97
110
|
environment?: string;
|
|
111
|
+
platform?: Platform;
|
|
98
112
|
sinks?: EventSink[];
|
|
99
113
|
sampleRate?: number;
|
|
100
114
|
redactKeys?: string[];
|
|
@@ -108,6 +122,7 @@ type HttpTrackingContext = {
|
|
|
108
122
|
type McpTrackingContext = {
|
|
109
123
|
sessionId?: string;
|
|
110
124
|
tenantId?: string;
|
|
125
|
+
platform?: Platform;
|
|
111
126
|
locale?: string;
|
|
112
127
|
userAgent?: string;
|
|
113
128
|
requestId?: string;
|
|
@@ -256,6 +271,20 @@ export declare class McpObservability {
|
|
|
256
271
|
private safeEmit;
|
|
257
272
|
}
|
|
258
273
|
export declare function createMcpObservability(options: ObservabilityOptions): McpObservability;
|
|
274
|
+
/**
|
|
275
|
+
* Detect the AI platform from available request signals.
|
|
276
|
+
*
|
|
277
|
+
* Returns 'claude', 'chatgpt', or 'other'. Unrecognised platforms
|
|
278
|
+
* are bucketed as 'other' — extend HEADER_RULES / META_PREFIX_MAP /
|
|
279
|
+
* CLIENT_NAME_MAP to add new known platforms.
|
|
280
|
+
*
|
|
281
|
+
* Detection order (first match wins):
|
|
282
|
+
* 1. HTTP headers — user-agent string and custom platform headers (e.g. x-openai-*, x-anthropic-*)
|
|
283
|
+
* 2. _meta key prefixes — namespaced keys in request.params._meta (e.g. "openai/session")
|
|
284
|
+
* 3. clientInfo.name — MCP initialize clientInfo (unreliable on some platforms)
|
|
285
|
+
* 4. Fallback — 'other' when any hints are provided but no known platform matched
|
|
286
|
+
*/
|
|
287
|
+
export declare function detectPlatform(hints?: PlatformHints): Platform;
|
|
259
288
|
export { RemoteSink, createRemoteSink, type RemoteSinkOptions, } from './remote-sink.js';
|
|
260
289
|
export { createMcpObservabilityEasy, type EasySetupConfig, } from './easy-setup.js';
|
|
261
290
|
export { createTelemetryRouter, expressTelemetry } from './endpoints.js';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjE,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC;AAEzC,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,QAAQ,CAAC;AAEb,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjE,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC;AAEzC,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,QAAQ,CAAC;AAEb,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;AAE3D,MAAM,MAAM,QAAQ,GAAG,aAAa,CAAC;AAErC,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,UAAU,CAAC,EAAE,aAAa,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,aAAa,GACb,OAAO,CAAC;AAEZ,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,MAAM,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC;CAC9C,CAAC;AAEF,qBAAa,YAAa,YAAW,SAAS;IAC5C,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;gBAEnB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAIxC,IAAI,CAAC,KAAK,EAAE,kBAAkB;IAO9B,SAAS,IAAI,kBAAkB,EAAE;IAIjC,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAwlB4B,MAAM;oBAAM,MAAM;uBAAS,MAAM;;;uBAI5D,MAAM;oBAAM,MAAM;uBAAS,MAAM;;;;CAljB7C;AAED,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,GAAG,SAAS,CAiCZ;AAED,wBAAgB,YAAY,CAAC,GAAG,KAAK,EAAE,SAAS,EAAE,GAAG,SAAS,CAiB7D;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IACpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IACzC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAC1C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAER;gBACZ,OAAO,EAAE,oBAAoB;IA6BzC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAe9D,gBAAgB,CACpB,GAAG,EAAE,eAAe,EACpB,GAAG,EAAE,cAAc,EACnB,OAAO,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC;IAsDtD,cAAc,CAAC,QAAQ,EAAE,SAAS,EAChC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,EAC9D,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,kBAAkB,GAClD,CAAC,OAAO,EAAE,QAAQ,KAAK,OAAO,CAAC,SAAS,CAAC;IA+E5C,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,SAAS,CAAC;IAWnE,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB;IAoBhE,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,eAAe;IAsBvB,OAAO,CAAC,QAAQ;CAejB;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,oBAAoB,oBAEnE;AA6CD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,QAAQ,CAwC9D;AAwKD,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,0BAA0B,EAC1B,KAAK,eAAe,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -211,6 +211,7 @@ export class McpObservability {
|
|
|
211
211
|
latencyMs: performance.now() - start,
|
|
212
212
|
tenantId: metadata.tenantId,
|
|
213
213
|
sessionId: metadata.sessionId,
|
|
214
|
+
platform: metadata.platform,
|
|
214
215
|
locale: metadata.locale,
|
|
215
216
|
userAgent: metadata.userAgent,
|
|
216
217
|
conversationId: metadata.conversationId,
|
|
@@ -252,6 +253,7 @@ export class McpObservability {
|
|
|
252
253
|
latencyMs: performance.now() - start,
|
|
253
254
|
tenantId: metadata.tenantId,
|
|
254
255
|
sessionId: metadata.sessionId,
|
|
256
|
+
platform: metadata.platform,
|
|
255
257
|
locale: metadata.locale,
|
|
256
258
|
userAgent: metadata.userAgent,
|
|
257
259
|
conversationId: metadata.conversationId,
|
|
@@ -343,6 +345,94 @@ export class McpObservability {
|
|
|
343
345
|
export function createMcpObservability(options) {
|
|
344
346
|
return new McpObservability(options);
|
|
345
347
|
}
|
|
348
|
+
const HEADER_RULES = [
|
|
349
|
+
// ChatGPT / OpenAI — user-agent contains "openai" or x-openai-* headers present
|
|
350
|
+
[
|
|
351
|
+
(ua, h) => ua.includes('openai') ||
|
|
352
|
+
Object.keys(h).some((k) => k.startsWith('x-openai-')),
|
|
353
|
+
'chatgpt',
|
|
354
|
+
],
|
|
355
|
+
// Claude / Anthropic — user-agent contains "claude" or "anthropic", or x-anthropic-* headers
|
|
356
|
+
[
|
|
357
|
+
(ua, h) => ua.includes('claude') ||
|
|
358
|
+
ua.includes('anthropic') ||
|
|
359
|
+
Object.keys(h).some((k) => k.startsWith('x-anthropic-')),
|
|
360
|
+
'claude',
|
|
361
|
+
],
|
|
362
|
+
];
|
|
363
|
+
// _meta key prefixes → platform
|
|
364
|
+
const META_PREFIX_MAP = [
|
|
365
|
+
['openai/', 'chatgpt'],
|
|
366
|
+
['anthropic/', 'claude'],
|
|
367
|
+
['claude/', 'claude'],
|
|
368
|
+
];
|
|
369
|
+
// clientInfo.name fallback map
|
|
370
|
+
const CLIENT_NAME_MAP = {
|
|
371
|
+
'claude-desktop': 'claude',
|
|
372
|
+
claude: 'claude',
|
|
373
|
+
chatgpt: 'chatgpt',
|
|
374
|
+
};
|
|
375
|
+
const IGNORED_CLIENT_NAMES = new Set([
|
|
376
|
+
'unavailable',
|
|
377
|
+
'unknown',
|
|
378
|
+
'n/a',
|
|
379
|
+
'none',
|
|
380
|
+
'',
|
|
381
|
+
]);
|
|
382
|
+
/**
|
|
383
|
+
* Detect the AI platform from available request signals.
|
|
384
|
+
*
|
|
385
|
+
* Returns 'claude', 'chatgpt', or 'other'. Unrecognised platforms
|
|
386
|
+
* are bucketed as 'other' — extend HEADER_RULES / META_PREFIX_MAP /
|
|
387
|
+
* CLIENT_NAME_MAP to add new known platforms.
|
|
388
|
+
*
|
|
389
|
+
* Detection order (first match wins):
|
|
390
|
+
* 1. HTTP headers — user-agent string and custom platform headers (e.g. x-openai-*, x-anthropic-*)
|
|
391
|
+
* 2. _meta key prefixes — namespaced keys in request.params._meta (e.g. "openai/session")
|
|
392
|
+
* 3. clientInfo.name — MCP initialize clientInfo (unreliable on some platforms)
|
|
393
|
+
* 4. Fallback — 'other' when any hints are provided but no known platform matched
|
|
394
|
+
*/
|
|
395
|
+
export function detectPlatform(hints) {
|
|
396
|
+
if (!hints)
|
|
397
|
+
return 'other';
|
|
398
|
+
// 1. Headers: normalise to lowercase keys, check user-agent + custom headers
|
|
399
|
+
if (hints.headers && Object.keys(hints.headers).length > 0) {
|
|
400
|
+
const lowerHeaders = {};
|
|
401
|
+
for (const [k, v] of Object.entries(hints.headers)) {
|
|
402
|
+
if (v !== undefined) {
|
|
403
|
+
lowerHeaders[k.toLowerCase()] = Array.isArray(v) ? v.join(', ') : v;
|
|
404
|
+
}
|
|
405
|
+
}
|
|
406
|
+
const ua = (lowerHeaders['user-agent'] ?? '').toLowerCase();
|
|
407
|
+
for (const [test, platform] of HEADER_RULES) {
|
|
408
|
+
if (test(ua, lowerHeaders))
|
|
409
|
+
return platform;
|
|
410
|
+
}
|
|
411
|
+
}
|
|
412
|
+
// 2. _meta key prefixes
|
|
413
|
+
if (hints.meta && typeof hints.meta === 'object') {
|
|
414
|
+
const keys = Object.keys(hints.meta);
|
|
415
|
+
for (const [prefix, platform] of META_PREFIX_MAP) {
|
|
416
|
+
if (keys.some((k) => k.toLowerCase().startsWith(prefix)))
|
|
417
|
+
return platform;
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
// 3. clientInfo.name fallback
|
|
421
|
+
if (hints.clientInfo?.name) {
|
|
422
|
+
const name = hints.clientInfo.name.toLowerCase().trim();
|
|
423
|
+
if (!IGNORED_CLIENT_NAMES.has(name)) {
|
|
424
|
+
if (CLIENT_NAME_MAP[name])
|
|
425
|
+
return CLIENT_NAME_MAP[name];
|
|
426
|
+
for (const [key, platform] of Object.entries(CLIENT_NAME_MAP)) {
|
|
427
|
+
if (name.startsWith(`${key}-`) || name.startsWith(`${key}/`)) {
|
|
428
|
+
return platform;
|
|
429
|
+
}
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
}
|
|
433
|
+
// 4. Nothing matched — bucket as 'other'
|
|
434
|
+
return 'other';
|
|
435
|
+
}
|
|
346
436
|
function hashPayload(payload) {
|
|
347
437
|
try {
|
|
348
438
|
const json = JSON.stringify(payload);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@listo-ai/mcp-observability",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Lightweight telemetry SDK for MCP servers and web applications. Captures HTTP requests, MCP tool invocations, business events, and UI interactions with built-in payload sanitization.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|