-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Expand file tree
/
Copy pathsessionExtraction.ts
More file actions
247 lines (222 loc) · 7.99 KB
/
sessionExtraction.ts
File metadata and controls
247 lines (222 loc) · 7.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
/**
* Session and party info extraction functions for MCP server instrumentation
*
* Handles extraction of client/server info and session data from MCP messages.
*/
import {
CLIENT_ADDRESS_ATTRIBUTE,
CLIENT_PORT_ATTRIBUTE,
MCP_PROTOCOL_VERSION_ATTRIBUTE,
MCP_SERVER_NAME_ATTRIBUTE,
MCP_SERVER_TITLE_ATTRIBUTE,
MCP_SERVER_VERSION_ATTRIBUTE,
MCP_SESSION_ID_ATTRIBUTE,
MCP_TRANSPORT_ATTRIBUTE,
NETWORK_PROTOCOL_VERSION_ATTRIBUTE,
NETWORK_TRANSPORT_ATTRIBUTE,
} from './attributes';
import {
getClientInfoForTransport,
getProtocolVersionForTransport,
getSessionDataForTransport,
} from './sessionManagement';
import type { ExtraHandlerData, JsonRpcRequest, MCPTransport, PartyInfo, SessionData } from './types';
import { isValidContentItem } from './validation';
/**
* Extracts and validates PartyInfo from an unknown object
* @param obj - Unknown object that might contain party info
* @returns Validated PartyInfo object with only string properties
*/
function extractPartyInfo(obj: unknown): PartyInfo {
const partyInfo: PartyInfo = {};
if (isValidContentItem(obj)) {
if (typeof obj.name === 'string') {
partyInfo.name = obj.name;
}
if (typeof obj.title === 'string') {
partyInfo.title = obj.title;
}
if (typeof obj.version === 'string') {
partyInfo.version = obj.version;
}
}
return partyInfo;
}
/**
* Extracts session data from "initialize" requests
* @param request - JSON-RPC "initialize" request containing client info and protocol version
* @returns Session data extracted from request parameters including protocol version and client info
*/
export function extractSessionDataFromInitializeRequest(request: JsonRpcRequest): SessionData {
const sessionData: SessionData = {};
if (isValidContentItem(request.params)) {
if (typeof request.params.protocolVersion === 'string') {
sessionData.protocolVersion = request.params.protocolVersion;
}
if (request.params.clientInfo) {
sessionData.clientInfo = extractPartyInfo(request.params.clientInfo);
}
}
return sessionData;
}
/**
* Extracts session data from "initialize" response
* @param result - "initialize" response result containing server info and protocol version
* @returns Partial session data extracted from response including protocol version and server info
*/
export function extractSessionDataFromInitializeResponse(result: unknown): Partial<SessionData> {
const sessionData: Partial<SessionData> = {};
if (isValidContentItem(result)) {
if (typeof result.protocolVersion === 'string') {
sessionData.protocolVersion = result.protocolVersion;
}
if (result.serverInfo) {
sessionData.serverInfo = extractPartyInfo(result.serverInfo);
}
}
return sessionData;
}
/**
* Build client attributes from stored client info
* @param transport - MCP transport instance
* @returns Client attributes for span instrumentation
*/
export function getClientAttributes(transport: MCPTransport): Record<string, string> {
const clientInfo = getClientInfoForTransport(transport);
const attributes: Record<string, string> = {};
if (clientInfo?.name) {
attributes['mcp.client.name'] = clientInfo.name;
}
if (clientInfo?.title) {
attributes['mcp.client.title'] = clientInfo.title;
}
if (clientInfo?.version) {
attributes['mcp.client.version'] = clientInfo.version;
}
return attributes;
}
/**
* Build client attributes from PartyInfo directly
* @param clientInfo - Client party info
* @returns Client attributes for span instrumentation
*/
export function buildClientAttributesFromInfo(clientInfo?: PartyInfo): Record<string, string> {
const attributes: Record<string, string> = {};
if (clientInfo?.name) {
attributes['mcp.client.name'] = clientInfo.name;
}
if (clientInfo?.title) {
attributes['mcp.client.title'] = clientInfo.title;
}
if (clientInfo?.version) {
attributes['mcp.client.version'] = clientInfo.version;
}
return attributes;
}
/**
* Build server attributes from stored server info
* @param transport - MCP transport instance
* @returns Server attributes for span instrumentation
*/
export function getServerAttributes(transport: MCPTransport): Record<string, string> {
const serverInfo = getSessionDataForTransport(transport)?.serverInfo;
const attributes: Record<string, string> = {};
if (serverInfo?.name) {
attributes[MCP_SERVER_NAME_ATTRIBUTE] = serverInfo.name;
}
if (serverInfo?.title) {
attributes[MCP_SERVER_TITLE_ATTRIBUTE] = serverInfo.title;
}
if (serverInfo?.version) {
attributes[MCP_SERVER_VERSION_ATTRIBUTE] = serverInfo.version;
}
return attributes;
}
/**
* Build server attributes from PartyInfo directly
* @param serverInfo - Server party info
* @returns Server attributes for span instrumentation
*/
export function buildServerAttributesFromInfo(serverInfo?: PartyInfo): Record<string, string> {
const attributes: Record<string, string> = {};
if (serverInfo?.name) {
attributes[MCP_SERVER_NAME_ATTRIBUTE] = serverInfo.name;
}
if (serverInfo?.title) {
attributes[MCP_SERVER_TITLE_ATTRIBUTE] = serverInfo.title;
}
if (serverInfo?.version) {
attributes[MCP_SERVER_VERSION_ATTRIBUTE] = serverInfo.version;
}
return attributes;
}
/**
* Extracts client connection info from extra handler data
* @param extra - Extra handler data containing connection info
* @returns Client address and port information
*/
export function extractClientInfo(extra: ExtraHandlerData): {
address?: string;
port?: number;
} {
return {
address:
extra?.requestInfo?.remoteAddress ||
extra?.clientAddress ||
extra?.request?.ip ||
extra?.request?.connection?.remoteAddress,
port: extra?.requestInfo?.remotePort || extra?.clientPort || extra?.request?.connection?.remotePort,
};
}
/**
* Extracts transport types based on transport constructor name
* @param transport - MCP transport instance
* @returns Transport type mapping for span attributes
*/
export function getTransportTypes(transport: MCPTransport): { mcpTransport: string; networkTransport: string } {
if (!transport?.constructor) {
return { mcpTransport: 'unknown', networkTransport: 'unknown' };
}
const transportName = typeof transport.constructor?.name === 'string' ? transport.constructor.name : 'unknown';
let networkTransport = 'unknown';
const lowerTransportName = transportName.toLowerCase();
if (lowerTransportName.includes('stdio')) {
networkTransport = 'pipe';
} else if (lowerTransportName.includes('http') || lowerTransportName.includes('sse')) {
networkTransport = 'tcp';
}
return {
mcpTransport: transportName,
networkTransport,
};
}
/**
* Build transport and network attributes
* @param transport - MCP transport instance
* @param extra - Optional extra handler data
* @returns Transport attributes for span instrumentation
* @note sessionId may be undefined during initial setup - session should be established by client during initialize flow
*/
export function buildTransportAttributes(
transport: MCPTransport,
extra?: ExtraHandlerData,
): Record<string, string | number> {
const sessionId = transport && 'sessionId' in transport ? transport.sessionId : undefined;
const clientInfo = extra ? extractClientInfo(extra) : {};
const { mcpTransport, networkTransport } = getTransportTypes(transport);
const clientAttributes = getClientAttributes(transport);
const serverAttributes = getServerAttributes(transport);
const protocolVersion = getProtocolVersionForTransport(transport);
const attributes = {
...(sessionId && { [MCP_SESSION_ID_ATTRIBUTE]: sessionId }),
...(clientInfo.address && { [CLIENT_ADDRESS_ATTRIBUTE]: clientInfo.address }),
...(clientInfo.port && { [CLIENT_PORT_ATTRIBUTE]: clientInfo.port }),
[MCP_TRANSPORT_ATTRIBUTE]: mcpTransport,
[NETWORK_TRANSPORT_ATTRIBUTE]: networkTransport,
[NETWORK_PROTOCOL_VERSION_ATTRIBUTE]: '2.0',
...(protocolVersion && { [MCP_PROTOCOL_VERSION_ATTRIBUTE]: protocolVersion }),
...clientAttributes,
...serverAttributes,
};
return attributes;
}