@fitchmultz/pi-mcp-adapter 5.0.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/CHANGELOG.md +750 -0
- package/LICENSE +21 -0
- package/OAUTH.md +462 -0
- package/README.md +820 -0
- package/abort.ts +34 -0
- package/agent-dir.ts +24 -0
- package/app-bridge.bundle.js +67 -0
- package/banner.png +0 -0
- package/checkpoint.ts +55 -0
- package/cli.js +222 -0
- package/commands.ts +619 -0
- package/config.ts +1204 -0
- package/consent-manager.ts +25 -0
- package/direct-tools.ts +408 -0
- package/dist/abort.d.ts +2 -0
- package/dist/abort.js +35 -0
- package/dist/agent-dir.d.ts +3 -0
- package/dist/agent-dir.js +21 -0
- package/dist/app-bridge.bundle.js +67 -0
- package/dist/checkpoint.d.ts +18 -0
- package/dist/checkpoint.js +53 -0
- package/dist/commands.d.ts +20 -0
- package/dist/commands.js +521 -0
- package/dist/config.d.ts +109 -0
- package/dist/config.js +1013 -0
- package/dist/consent-manager.d.ts +8 -0
- package/dist/consent-manager.js +21 -0
- package/dist/direct-tools.d.ts +10 -0
- package/dist/direct-tools.js +350 -0
- package/dist/docs/client-metadata.json +14 -0
- package/dist/elicitation-handler.d.ts +17 -0
- package/dist/elicitation-handler.js +308 -0
- package/dist/error-signal.d.ts +15 -0
- package/dist/error-signal.js +21 -0
- package/dist/glimpse-ui.d.ts +9 -0
- package/dist/glimpse-ui.js +75 -0
- package/dist/host-html-template.d.ts +15 -0
- package/dist/host-html-template.js +429 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +840 -0
- package/dist/init.d.ts +25 -0
- package/dist/init.js +562 -0
- package/dist/legacy-migration.d.ts +18 -0
- package/dist/legacy-migration.js +45 -0
- package/dist/lifecycle.d.ts +40 -0
- package/dist/lifecycle.js +167 -0
- package/dist/logger.d.ts +38 -0
- package/dist/logger.js +102 -0
- package/dist/mcp-auth-flow.d.ts +113 -0
- package/dist/mcp-auth-flow.js +834 -0
- package/dist/mcp-auth.d.ts +127 -0
- package/dist/mcp-auth.js +658 -0
- package/dist/mcp-callback-server.d.ts +56 -0
- package/dist/mcp-callback-server.js +371 -0
- package/dist/mcp-code.d.ts +51 -0
- package/dist/mcp-code.js +366 -0
- package/dist/mcp-keyring-helper.cjs +89 -0
- package/dist/mcp-oauth-provider.d.ts +154 -0
- package/dist/mcp-oauth-provider.js +672 -0
- package/dist/mcp-output-guard.d.ts +59 -0
- package/dist/mcp-output-guard.js +332 -0
- package/dist/mcp-panel.d.ts +66 -0
- package/dist/mcp-panel.js +889 -0
- package/dist/mcp-script-worker.mjs +128 -0
- package/dist/mcp-setup-panel.d.ts +84 -0
- package/dist/mcp-setup-panel.js +561 -0
- package/dist/mcp-status.d.ts +11 -0
- package/dist/mcp-status.js +96 -0
- package/dist/mcp-trace.d.ts +95 -0
- package/dist/mcp-trace.js +233 -0
- package/dist/metadata-cache.d.ts +18 -0
- package/dist/metadata-cache.js +277 -0
- package/dist/npx-resolver.d.ts +6 -0
- package/dist/npx-resolver.js +448 -0
- package/dist/onboarding-state.d.ts +11 -0
- package/dist/onboarding-state.js +47 -0
- package/dist/panel-keys.d.ts +16 -0
- package/dist/panel-keys.js +15 -0
- package/dist/prompts.d.ts +56 -0
- package/dist/prompts.js +284 -0
- package/dist/proxy-modes.d.ts +38 -0
- package/dist/proxy-modes.js +1235 -0
- package/dist/resource-tools.d.ts +1 -0
- package/dist/resource-tools.js +14 -0
- package/dist/runtime-owner.d.ts +18 -0
- package/dist/runtime-owner.js +117 -0
- package/dist/sampling-handler.d.ts +15 -0
- package/dist/sampling-handler.js +211 -0
- package/dist/search-ranking.d.ts +20 -0
- package/dist/search-ranking.js +180 -0
- package/dist/server-manager.d.ts +114 -0
- package/dist/server-manager.js +1175 -0
- package/dist/session-recovery.d.ts +31 -0
- package/dist/session-recovery.js +310 -0
- package/dist/state.d.ts +63 -0
- package/dist/state.js +1 -0
- package/dist/tool-approval.d.ts +10 -0
- package/dist/tool-approval.js +42 -0
- package/dist/tool-metadata.d.ts +9 -0
- package/dist/tool-metadata.js +193 -0
- package/dist/tool-registrar.d.ts +10 -0
- package/dist/tool-registrar.js +64 -0
- package/dist/tool-result-renderer.d.ts +45 -0
- package/dist/tool-result-renderer.js +224 -0
- package/dist/ts-shape.d.ts +2 -0
- package/dist/ts-shape.js +147 -0
- package/dist/types.d.ts +516 -0
- package/dist/types.js +168 -0
- package/dist/ui-resource-handler.d.ts +17 -0
- package/dist/ui-resource-handler.js +209 -0
- package/dist/ui-server.d.ts +51 -0
- package/dist/ui-server.js +669 -0
- package/dist/ui-session.d.ts +39 -0
- package/dist/ui-session.js +463 -0
- package/dist/ui-stream-types.d.ts +104 -0
- package/dist/ui-stream-types.js +58 -0
- package/dist/ui-tool-visibility.d.ts +4 -0
- package/dist/ui-tool-visibility.js +26 -0
- package/dist/unix-socket-transport.d.ts +15 -0
- package/dist/unix-socket-transport.js +84 -0
- package/dist/utils.d.ts +30 -0
- package/dist/utils.js +276 -0
- package/docs/client-metadata.json +14 -0
- package/elicitation-handler.ts +349 -0
- package/error-signal.ts +21 -0
- package/glimpse-ui.ts +80 -0
- package/host-html-template.ts +456 -0
- package/index.ts +900 -0
- package/init.ts +627 -0
- package/legacy-migration.ts +47 -0
- package/lifecycle.ts +165 -0
- package/logger.ts +127 -0
- package/mcp-auth-flow.ts +975 -0
- package/mcp-auth.ts +793 -0
- package/mcp-callback-server.ts +450 -0
- package/mcp-code.ts +386 -0
- package/mcp-keyring-helper.cjs +89 -0
- package/mcp-oauth-provider.ts +774 -0
- package/mcp-output-guard.ts +412 -0
- package/mcp-panel.ts +978 -0
- package/mcp-script-worker.mjs +128 -0
- package/mcp-setup-panel.ts +666 -0
- package/mcp-status.ts +109 -0
- package/mcp-trace.ts +295 -0
- package/metadata-cache.ts +333 -0
- package/npx-resolver.ts +488 -0
- package/onboarding-state.ts +58 -0
- package/package.json +182 -0
- package/panel-keys.ts +37 -0
- package/prompts.ts +337 -0
- package/proxy-modes.ts +1361 -0
- package/resource-tools.ts +17 -0
- package/runtime-owner.ts +123 -0
- package/sampling-handler.ts +273 -0
- package/scripts/build.mjs +131 -0
- package/scripts/prepare.mjs +102 -0
- package/search-ranking.ts +196 -0
- package/server-manager.ts +1320 -0
- package/session-recovery.ts +316 -0
- package/skills/mcp-scripting/SKILL.md +38 -0
- package/state.ts +64 -0
- package/tool-approval.ts +78 -0
- package/tool-metadata.ts +235 -0
- package/tool-registrar.ts +69 -0
- package/tool-result-renderer.ts +286 -0
- package/ts-shape.ts +145 -0
- package/tsconfig.build.json +13 -0
- package/tsconfig.json +16 -0
- package/types.ts +810 -0
- package/ui-resource-handler.ts +249 -0
- package/ui-server.ts +808 -0
- package/ui-session.ts +568 -0
- package/ui-stream-types.ts +89 -0
- package/ui-tool-visibility.ts +25 -0
- package/unix-socket-transport.ts +85 -0
- package/utils.ts +309 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import type { Transport } from "@modelcontextprotocol/client";
|
|
2
|
+
import type { JSONRPCMessage } from "@modelcontextprotocol/client";
|
|
3
|
+
export declare const MCP_TRACE_SCHEMA_VERSION = 1;
|
|
4
|
+
export declare const DEFAULT_MCP_TRACE_MAX_BYTES: number;
|
|
5
|
+
export declare const DEFAULT_MCP_TRACE_MAX_EVENTS = 10000;
|
|
6
|
+
export type McpTraceDirection = "outbound" | "inbound";
|
|
7
|
+
export type McpTraceTransport = "stdio" | "unix-socket" | "sse" | "streamable-http" | "unknown";
|
|
8
|
+
export type McpTraceMessageKind = "request" | "response" | "notification";
|
|
9
|
+
export interface McpTraceSettings {
|
|
10
|
+
/** Enable metadata-only protocol tracing for all servers unless overridden. */
|
|
11
|
+
enabled?: boolean;
|
|
12
|
+
/** JSONL destination. Relative paths are resolved from the session cwd. */
|
|
13
|
+
file?: string;
|
|
14
|
+
/** Maximum bytes retained in the per-session JSONL file. */
|
|
15
|
+
maxBytes?: number;
|
|
16
|
+
/** Maximum events retained in the per-session JSONL file. */
|
|
17
|
+
maxEvents?: number;
|
|
18
|
+
}
|
|
19
|
+
export interface McpTraceEvent {
|
|
20
|
+
version: typeof MCP_TRACE_SCHEMA_VERSION;
|
|
21
|
+
timestamp: string;
|
|
22
|
+
direction: McpTraceDirection;
|
|
23
|
+
server: string;
|
|
24
|
+
transport: McpTraceTransport;
|
|
25
|
+
kind: McpTraceMessageKind;
|
|
26
|
+
status: "sent" | "received" | "error";
|
|
27
|
+
method?: string;
|
|
28
|
+
id?: string | number | null;
|
|
29
|
+
relatedRequestId?: string | number;
|
|
30
|
+
errorCode?: number | string;
|
|
31
|
+
bytes?: number;
|
|
32
|
+
durationMs?: number;
|
|
33
|
+
}
|
|
34
|
+
export interface McpTraceWriterOptions {
|
|
35
|
+
filePath: string;
|
|
36
|
+
maxBytes?: number;
|
|
37
|
+
maxEvents?: number;
|
|
38
|
+
appendFile?: (path: string, data: string, options: {
|
|
39
|
+
encoding: "utf8";
|
|
40
|
+
}) => Promise<void>;
|
|
41
|
+
writeFile?: (path: string, data: string, options: {
|
|
42
|
+
encoding: "utf8";
|
|
43
|
+
}) => Promise<void>;
|
|
44
|
+
mkdir?: (path: string, options: {
|
|
45
|
+
recursive: true;
|
|
46
|
+
}) => Promise<string | undefined>;
|
|
47
|
+
}
|
|
48
|
+
/** Redact strings before they can become durable trace metadata. */
|
|
49
|
+
export declare function redactTraceText(value: string, maxLength?: number): string;
|
|
50
|
+
export declare function createMcpTraceEvent(direction: McpTraceDirection, server: string, transport: McpTraceTransport, message: JSONRPCMessage, status: "sent" | "received" | "error", options?: {
|
|
51
|
+
relatedRequestId?: unknown;
|
|
52
|
+
durationMs?: number;
|
|
53
|
+
}): McpTraceEvent;
|
|
54
|
+
export declare class McpTraceWriter {
|
|
55
|
+
private readonly options;
|
|
56
|
+
private readonly maxBytes;
|
|
57
|
+
private readonly maxEvents;
|
|
58
|
+
private readonly append;
|
|
59
|
+
private readonly resetFile;
|
|
60
|
+
private readonly makeDirectory;
|
|
61
|
+
private bytesWritten;
|
|
62
|
+
private eventsWritten;
|
|
63
|
+
private queue;
|
|
64
|
+
private disabled;
|
|
65
|
+
private initializationFailed;
|
|
66
|
+
private persistenceError;
|
|
67
|
+
private readonly fileReady;
|
|
68
|
+
constructor(options: McpTraceWriterOptions);
|
|
69
|
+
get filePath(): string;
|
|
70
|
+
get isDisabled(): boolean;
|
|
71
|
+
get stats(): {
|
|
72
|
+
bytes: number;
|
|
73
|
+
events: number;
|
|
74
|
+
};
|
|
75
|
+
write(event: McpTraceEvent): void;
|
|
76
|
+
flush(strict?: boolean): Promise<void>;
|
|
77
|
+
}
|
|
78
|
+
export declare function createMcpTraceWriter(sessionCwd: string | undefined, settings?: McpTraceSettings, randomSuffix?: string): McpTraceWriter;
|
|
79
|
+
export interface McpTraceObserver {
|
|
80
|
+
record(event: McpTraceEvent): void;
|
|
81
|
+
}
|
|
82
|
+
export declare function isMcpTraceEnabled(definition: {
|
|
83
|
+
trace?: boolean;
|
|
84
|
+
}, settings?: McpTraceSettings): boolean;
|
|
85
|
+
/**
|
|
86
|
+
* Compose the SDK's transport callbacks instead of replacing them. Protocol
|
|
87
|
+
* assigns `onmessage` during connect, so the setter must keep the observer in
|
|
88
|
+
* front of whichever callback the SDK installs.
|
|
89
|
+
*/
|
|
90
|
+
export declare function wrapTransportWithMcpTrace(transport: Transport, server: string, transportKind: McpTraceTransport, observer: McpTraceObserver): Transport;
|
|
91
|
+
export declare function traceTransportKind(definition: {
|
|
92
|
+
command?: string;
|
|
93
|
+
url?: string;
|
|
94
|
+
socket?: string;
|
|
95
|
+
}, transport: Transport): McpTraceTransport;
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import { appendFile, mkdir, writeFile } from "node:fs/promises";
|
|
2
|
+
import { Buffer } from "node:buffer";
|
|
3
|
+
import { dirname, isAbsolute, resolve } from "node:path";
|
|
4
|
+
export const MCP_TRACE_SCHEMA_VERSION = 1;
|
|
5
|
+
export const DEFAULT_MCP_TRACE_MAX_BYTES = 256 * 1024;
|
|
6
|
+
export const DEFAULT_MCP_TRACE_MAX_EVENTS = 10_000;
|
|
7
|
+
function boundedPositiveInteger(value, fallback) {
|
|
8
|
+
if (!Number.isFinite(value) || value === undefined || value <= 0)
|
|
9
|
+
return fallback;
|
|
10
|
+
return Math.floor(value);
|
|
11
|
+
}
|
|
12
|
+
/** Redact strings before they can become durable trace metadata. */
|
|
13
|
+
export function redactTraceText(value, maxLength = 160) {
|
|
14
|
+
if (/\b(?:token|secret|password|passwd|api[_-]?key|authorization|cookie)\b/i.test(value)) {
|
|
15
|
+
return "[REDACTED]";
|
|
16
|
+
}
|
|
17
|
+
let redacted = value
|
|
18
|
+
.replace(/\b[a-z][a-z\d+.-]*:\/\/[^\s"'<>]+/gi, "[REDACTED_URL]")
|
|
19
|
+
.replace(/\b(?:bearer|basic)\s+[A-Za-z0-9._~+/=-]+/gi, "[REDACTED_AUTH]")
|
|
20
|
+
.replace(/\b(?:token|secret|password|passwd|api[_-]?key|authorization|cookie)\s*[:=]\s*[^\s,;]+/gi, "$1=[REDACTED]");
|
|
21
|
+
if (redacted.length > maxLength)
|
|
22
|
+
redacted = `${redacted.slice(0, maxLength - 1)}…`;
|
|
23
|
+
return redacted;
|
|
24
|
+
}
|
|
25
|
+
function messageKind(message) {
|
|
26
|
+
if ("method" in message)
|
|
27
|
+
return "id" in message ? "request" : "notification";
|
|
28
|
+
return "response";
|
|
29
|
+
}
|
|
30
|
+
function traceId(value) {
|
|
31
|
+
if (value === null)
|
|
32
|
+
return null;
|
|
33
|
+
if (typeof value === "number" && Number.isFinite(value))
|
|
34
|
+
return value;
|
|
35
|
+
if (typeof value === "string")
|
|
36
|
+
return "[REDACTED_ID]";
|
|
37
|
+
return undefined;
|
|
38
|
+
}
|
|
39
|
+
function messageBytes(message) {
|
|
40
|
+
try {
|
|
41
|
+
return Buffer.byteLength(JSON.stringify(message), "utf8");
|
|
42
|
+
}
|
|
43
|
+
catch {
|
|
44
|
+
return undefined;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
export function createMcpTraceEvent(direction, server, transport, message, status, options) {
|
|
48
|
+
const kind = messageKind(message);
|
|
49
|
+
const bytes = messageBytes(message);
|
|
50
|
+
const event = {
|
|
51
|
+
version: MCP_TRACE_SCHEMA_VERSION,
|
|
52
|
+
timestamp: new Date().toISOString(),
|
|
53
|
+
direction,
|
|
54
|
+
server: redactTraceText(server, 120),
|
|
55
|
+
transport,
|
|
56
|
+
kind,
|
|
57
|
+
status,
|
|
58
|
+
...(bytes !== undefined ? { bytes } : {}),
|
|
59
|
+
};
|
|
60
|
+
if ("method" in message)
|
|
61
|
+
event.method = redactTraceText(message.method, 120);
|
|
62
|
+
if ("id" in message)
|
|
63
|
+
event.id = traceId(message.id) ?? null;
|
|
64
|
+
const relatedRequestId = traceId(options?.relatedRequestId);
|
|
65
|
+
if (relatedRequestId !== undefined && relatedRequestId !== null)
|
|
66
|
+
event.relatedRequestId = relatedRequestId;
|
|
67
|
+
if ("error" in message && message.error && typeof message.error.code === "number") {
|
|
68
|
+
event.errorCode = message.error.code;
|
|
69
|
+
}
|
|
70
|
+
if (options?.durationMs !== undefined && Number.isFinite(options.durationMs)) {
|
|
71
|
+
event.durationMs = Math.max(0, Math.round(options.durationMs * 100) / 100);
|
|
72
|
+
}
|
|
73
|
+
return event;
|
|
74
|
+
}
|
|
75
|
+
export class McpTraceWriter {
|
|
76
|
+
options;
|
|
77
|
+
maxBytes;
|
|
78
|
+
maxEvents;
|
|
79
|
+
append;
|
|
80
|
+
resetFile;
|
|
81
|
+
makeDirectory;
|
|
82
|
+
bytesWritten = 0;
|
|
83
|
+
eventsWritten = 0;
|
|
84
|
+
queue = Promise.resolve();
|
|
85
|
+
disabled = false;
|
|
86
|
+
initializationFailed = false;
|
|
87
|
+
persistenceError;
|
|
88
|
+
fileReady;
|
|
89
|
+
constructor(options) {
|
|
90
|
+
this.options = options;
|
|
91
|
+
this.maxBytes = boundedPositiveInteger(options.maxBytes, DEFAULT_MCP_TRACE_MAX_BYTES);
|
|
92
|
+
this.maxEvents = boundedPositiveInteger(options.maxEvents, DEFAULT_MCP_TRACE_MAX_EVENTS);
|
|
93
|
+
this.append = options.appendFile ?? (async (path, data, appendOptions) => {
|
|
94
|
+
await appendFile(path, data, appendOptions);
|
|
95
|
+
});
|
|
96
|
+
this.resetFile = options.writeFile ?? (async (path, data, writeOptions) => {
|
|
97
|
+
await writeFile(path, data, writeOptions);
|
|
98
|
+
});
|
|
99
|
+
this.makeDirectory = options.mkdir ?? (async (path) => {
|
|
100
|
+
await mkdir(path, { recursive: true });
|
|
101
|
+
return undefined;
|
|
102
|
+
});
|
|
103
|
+
this.fileReady = this.makeDirectory(dirname(this.options.filePath), { recursive: true })
|
|
104
|
+
.then(() => this.resetFile(this.options.filePath, "", { encoding: "utf8" }))
|
|
105
|
+
.catch(error => {
|
|
106
|
+
// Tracing must never change MCP request/response behavior.
|
|
107
|
+
this.persistenceError = error;
|
|
108
|
+
this.initializationFailed = true;
|
|
109
|
+
this.disabled = true;
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
get filePath() {
|
|
113
|
+
return this.options.filePath;
|
|
114
|
+
}
|
|
115
|
+
get isDisabled() {
|
|
116
|
+
return this.disabled;
|
|
117
|
+
}
|
|
118
|
+
get stats() {
|
|
119
|
+
return { bytes: this.bytesWritten, events: this.eventsWritten };
|
|
120
|
+
}
|
|
121
|
+
write(event) {
|
|
122
|
+
if (this.disabled || this.eventsWritten >= this.maxEvents)
|
|
123
|
+
return;
|
|
124
|
+
let line;
|
|
125
|
+
try {
|
|
126
|
+
line = `${JSON.stringify(event)}\n`;
|
|
127
|
+
}
|
|
128
|
+
catch {
|
|
129
|
+
this.disabled = true;
|
|
130
|
+
return;
|
|
131
|
+
}
|
|
132
|
+
const bytes = Buffer.byteLength(line, "utf8");
|
|
133
|
+
if (bytes > this.maxBytes - this.bytesWritten) {
|
|
134
|
+
this.disabled = true;
|
|
135
|
+
return;
|
|
136
|
+
}
|
|
137
|
+
this.bytesWritten += bytes;
|
|
138
|
+
this.eventsWritten += 1;
|
|
139
|
+
this.queue = this.queue.then(async () => {
|
|
140
|
+
await this.fileReady;
|
|
141
|
+
if (this.initializationFailed)
|
|
142
|
+
return;
|
|
143
|
+
await this.append(this.options.filePath, line, { encoding: "utf8" });
|
|
144
|
+
}).catch(error => {
|
|
145
|
+
// Tracing must never change MCP request/response behavior.
|
|
146
|
+
this.persistenceError ??= error;
|
|
147
|
+
this.disabled = true;
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
async flush(strict = false) {
|
|
151
|
+
await this.fileReady;
|
|
152
|
+
await this.queue;
|
|
153
|
+
if (strict && this.persistenceError !== undefined)
|
|
154
|
+
throw this.persistenceError;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
export function createMcpTraceWriter(sessionCwd, settings = {}, randomSuffix = Math.random().toString(36).slice(2, 10)) {
|
|
158
|
+
const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
|
|
159
|
+
const configuredPath = settings.file;
|
|
160
|
+
const filePath = configuredPath
|
|
161
|
+
? (isAbsolute(configuredPath) ? configuredPath : resolve(sessionCwd ?? process.cwd(), configuredPath))
|
|
162
|
+
: resolve(sessionCwd ?? process.cwd(), ".pi", "fitch-mcp-adapter", "traces", `mcp-${timestamp}-${randomSuffix}.jsonl`);
|
|
163
|
+
return new McpTraceWriter({
|
|
164
|
+
filePath,
|
|
165
|
+
...(settings.maxBytes !== undefined ? { maxBytes: settings.maxBytes } : {}),
|
|
166
|
+
...(settings.maxEvents !== undefined ? { maxEvents: settings.maxEvents } : {}),
|
|
167
|
+
});
|
|
168
|
+
}
|
|
169
|
+
export function isMcpTraceEnabled(definition, settings) {
|
|
170
|
+
return definition.trace ?? settings?.enabled === true;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Compose the SDK's transport callbacks instead of replacing them. Protocol
|
|
174
|
+
* assigns `onmessage` during connect, so the setter must keep the observer in
|
|
175
|
+
* front of whichever callback the SDK installs.
|
|
176
|
+
*/
|
|
177
|
+
export function wrapTransportWithMcpTrace(transport, server, transportKind, observer) {
|
|
178
|
+
let messageHandler = transport.onmessage;
|
|
179
|
+
const record = (event) => {
|
|
180
|
+
try {
|
|
181
|
+
observer.record(event);
|
|
182
|
+
}
|
|
183
|
+
catch {
|
|
184
|
+
// An observer failure must never alter SDK transport behavior.
|
|
185
|
+
}
|
|
186
|
+
};
|
|
187
|
+
// Instrument the native instance: the SDK inspects stdio identity and HTTP
|
|
188
|
+
// hasPerRequestStream to choose negotiation and cancellation behavior.
|
|
189
|
+
const send = transport.send.bind(transport);
|
|
190
|
+
transport.send = async (message, options) => {
|
|
191
|
+
const started = performance.now();
|
|
192
|
+
const messages = Array.isArray(message) ? message : [message];
|
|
193
|
+
try {
|
|
194
|
+
await send(message, options);
|
|
195
|
+
for (const item of messages) {
|
|
196
|
+
record(createMcpTraceEvent("outbound", server, transportKind, item, "sent", {
|
|
197
|
+
durationMs: performance.now() - started,
|
|
198
|
+
}));
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
catch (error) {
|
|
202
|
+
for (const item of messages) {
|
|
203
|
+
record(createMcpTraceEvent("outbound", server, transportKind, item, "error", {
|
|
204
|
+
durationMs: performance.now() - started,
|
|
205
|
+
}));
|
|
206
|
+
}
|
|
207
|
+
throw error;
|
|
208
|
+
}
|
|
209
|
+
};
|
|
210
|
+
Object.defineProperty(transport, "onmessage", {
|
|
211
|
+
configurable: true,
|
|
212
|
+
get: () => messageHandler,
|
|
213
|
+
set: (handler) => {
|
|
214
|
+
messageHandler = handler ? (message, extra) => {
|
|
215
|
+
record(createMcpTraceEvent("inbound", server, transportKind, message, "received"));
|
|
216
|
+
handler(message, extra);
|
|
217
|
+
} : undefined;
|
|
218
|
+
},
|
|
219
|
+
});
|
|
220
|
+
return transport;
|
|
221
|
+
}
|
|
222
|
+
export function traceTransportKind(definition, transport) {
|
|
223
|
+
if (definition.command)
|
|
224
|
+
return "stdio";
|
|
225
|
+
if (definition.socket)
|
|
226
|
+
return "unix-socket";
|
|
227
|
+
const constructorName = transport.constructor?.name.toLowerCase() ?? "";
|
|
228
|
+
if (constructorName.includes("sse"))
|
|
229
|
+
return "sse";
|
|
230
|
+
if (constructorName.includes("streamable"))
|
|
231
|
+
return "streamable-http";
|
|
232
|
+
return definition.url ? "streamable-http" : "unknown";
|
|
233
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { CachedPrompt, CachedResource, CachedTool, McpConfig, McpTool, McpResource, McpPrompt, MetadataCache, ServerCacheEntry, ServerEntry, ToolMetadata, PromptMetadata } from "./types.ts";
|
|
2
|
+
import { type ToolPrefix } from "./types.ts";
|
|
3
|
+
export type { CachedPrompt, CachedResource, CachedTool, MetadataCache, ServerCacheEntry } from "./types.ts";
|
|
4
|
+
export declare function getMetadataCachePath(): string;
|
|
5
|
+
export declare function loadMetadataCache(enabled?: boolean): MetadataCache | null;
|
|
6
|
+
export declare function saveMetadataCache(cache: MetadataCache, enabled?: boolean): void;
|
|
7
|
+
export declare function computeServerHash(definition: ServerEntry): string;
|
|
8
|
+
export declare function isServerCacheValid(entry: ServerCacheEntry, definition: ServerEntry, maxAgeMs?: number): boolean;
|
|
9
|
+
export declare function parseDirectToolSelectors(selectors: string[]): {
|
|
10
|
+
servers: Set<string>;
|
|
11
|
+
tools: Map<string, Set<string>>;
|
|
12
|
+
};
|
|
13
|
+
export declare function getMissingConfiguredDirectToolServers(config: McpConfig, cache: MetadataCache | null, envOverride?: string[]): string[];
|
|
14
|
+
export declare function reconstructToolMetadata(serverName: string, entry: ServerCacheEntry, prefix: ToolPrefix, definition: Pick<ServerEntry, "exposeResources" | "includeTools" | "excludeTools" | "toolPrefix">): ToolMetadata[];
|
|
15
|
+
export declare function serializeTools(tools: McpTool[]): CachedTool[];
|
|
16
|
+
export declare function serializeResources(resources: McpResource[]): CachedResource[];
|
|
17
|
+
export declare function serializePrompts(prompts: McpPrompt[]): CachedPrompt[];
|
|
18
|
+
export declare function reconstructPromptMetadata(serverName: string, prompts: ReadonlyArray<McpPrompt | CachedPrompt>, prefix: ToolPrefix, definition?: Pick<ServerEntry, "toolPrefix">): PromptMetadata[];
|
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
// metadata-cache.ts - Persistent MCP metadata cache
|
|
2
|
+
import { existsSync, readFileSync, writeFileSync, renameSync, mkdirSync } from "node:fs";
|
|
3
|
+
import { dirname } from "node:path";
|
|
4
|
+
import { getAdapterPath } from "./agent-dir.js";
|
|
5
|
+
import { createHash } from "node:crypto";
|
|
6
|
+
import { getToolUiResourceUri } from "@modelcontextprotocol/ext-apps/app-bridge";
|
|
7
|
+
import { formatPromptCommandName, formatToolName, isServerDisabled, isToolAllowed, resolveToolPrefix } from "./types.js";
|
|
8
|
+
import { resourceNameToToolName } from "./resource-tools.js";
|
|
9
|
+
import { extractToolUiStreamMode, interpolateEnvRecord, resolveBearerToken, resolveConfigPath, resolveServerUrl, } from "./utils.js";
|
|
10
|
+
import { extractUiToolVisibility, isUiToolVisibleToModel } from "./ui-tool-visibility.js";
|
|
11
|
+
const CACHE_VERSION = 1;
|
|
12
|
+
const CACHE_MAX_AGE_MS = 7 * 24 * 60 * 60 * 1000;
|
|
13
|
+
export function getMetadataCachePath() {
|
|
14
|
+
return getAdapterPath("mcp-cache.json");
|
|
15
|
+
}
|
|
16
|
+
export function loadMetadataCache(enabled = true) {
|
|
17
|
+
if (!enabled)
|
|
18
|
+
return null;
|
|
19
|
+
const cachePath = getMetadataCachePath();
|
|
20
|
+
if (!existsSync(cachePath))
|
|
21
|
+
return null;
|
|
22
|
+
try {
|
|
23
|
+
const raw = JSON.parse(readFileSync(cachePath, "utf-8"));
|
|
24
|
+
if (!raw || typeof raw !== "object")
|
|
25
|
+
return null;
|
|
26
|
+
if (raw.version !== CACHE_VERSION)
|
|
27
|
+
return null;
|
|
28
|
+
if (!raw.servers || typeof raw.servers !== "object")
|
|
29
|
+
return null;
|
|
30
|
+
return raw;
|
|
31
|
+
}
|
|
32
|
+
catch {
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
export function saveMetadataCache(cache, enabled = true) {
|
|
37
|
+
if (!enabled)
|
|
38
|
+
return;
|
|
39
|
+
const cachePath = getMetadataCachePath();
|
|
40
|
+
const dir = dirname(cachePath);
|
|
41
|
+
mkdirSync(dir, { recursive: true });
|
|
42
|
+
let merged = { version: CACHE_VERSION, servers: {} };
|
|
43
|
+
try {
|
|
44
|
+
if (existsSync(cachePath)) {
|
|
45
|
+
const existing = JSON.parse(readFileSync(cachePath, "utf-8"));
|
|
46
|
+
if (existing && existing.version === CACHE_VERSION && existing.servers) {
|
|
47
|
+
merged.servers = { ...existing.servers };
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
catch {
|
|
52
|
+
// Ignore parse errors and proceed with empty cache
|
|
53
|
+
}
|
|
54
|
+
merged.version = CACHE_VERSION;
|
|
55
|
+
merged.servers = { ...merged.servers, ...cache.servers };
|
|
56
|
+
const tmpPath = `${cachePath}.${process.pid}.tmp`;
|
|
57
|
+
writeFileSync(tmpPath, JSON.stringify(merged, null, 2), "utf-8");
|
|
58
|
+
renameSync(tmpPath, cachePath);
|
|
59
|
+
}
|
|
60
|
+
export function computeServerHash(definition) {
|
|
61
|
+
// Hash only fields that affect server identity and tool/resource output.
|
|
62
|
+
// Exclude lifecycle, idleTimeout, requestTimeoutMs, debug — those are runtime behavior settings
|
|
63
|
+
// that don't change which tools a server exposes.
|
|
64
|
+
const identity = {
|
|
65
|
+
command: definition.command,
|
|
66
|
+
args: definition.args,
|
|
67
|
+
socket: resolveConfigPath(definition.socket),
|
|
68
|
+
env: interpolateEnvRecord(definition.env),
|
|
69
|
+
cwd: resolveConfigPath(definition.cwd),
|
|
70
|
+
url: resolveServerUrl(definition),
|
|
71
|
+
headers: interpolateEnvRecord(definition.headers),
|
|
72
|
+
auth: definition.auth,
|
|
73
|
+
bearerToken: resolveBearerToken(definition),
|
|
74
|
+
bearerTokenEnv: definition.bearerTokenEnv,
|
|
75
|
+
exposeResources: definition.exposeResources,
|
|
76
|
+
includeTools: definition.includeTools,
|
|
77
|
+
excludeTools: definition.excludeTools,
|
|
78
|
+
};
|
|
79
|
+
const normalized = stableStringify(identity);
|
|
80
|
+
return createHash("sha256").update(normalized).digest("hex");
|
|
81
|
+
}
|
|
82
|
+
export function isServerCacheValid(entry, definition, maxAgeMs = CACHE_MAX_AGE_MS) {
|
|
83
|
+
let configHash;
|
|
84
|
+
try {
|
|
85
|
+
configHash = computeServerHash(definition);
|
|
86
|
+
}
|
|
87
|
+
catch {
|
|
88
|
+
return false;
|
|
89
|
+
}
|
|
90
|
+
if (!entry || entry.configHash !== configHash)
|
|
91
|
+
return false;
|
|
92
|
+
if (!entry.cachedAt || typeof entry.cachedAt !== "number")
|
|
93
|
+
return false;
|
|
94
|
+
if (maxAgeMs > 0 && Date.now() - entry.cachedAt > maxAgeMs)
|
|
95
|
+
return false;
|
|
96
|
+
return true;
|
|
97
|
+
}
|
|
98
|
+
export function parseDirectToolSelectors(selectors) {
|
|
99
|
+
const servers = new Set();
|
|
100
|
+
const tools = new Map();
|
|
101
|
+
for (let selector of selectors) {
|
|
102
|
+
selector = selector.replace(/\/+$/, "");
|
|
103
|
+
if (selector.includes("/")) {
|
|
104
|
+
const [server, tool] = selector.split("/", 2);
|
|
105
|
+
if (server && tool) {
|
|
106
|
+
const serverTools = tools.get(server) ?? new Set();
|
|
107
|
+
serverTools.add(tool);
|
|
108
|
+
tools.set(server, serverTools);
|
|
109
|
+
}
|
|
110
|
+
else if (server) {
|
|
111
|
+
servers.add(server);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
else if (selector) {
|
|
115
|
+
servers.add(selector);
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
return { servers, tools };
|
|
119
|
+
}
|
|
120
|
+
export function getMissingConfiguredDirectToolServers(config, cache, envOverride) {
|
|
121
|
+
const missing = [];
|
|
122
|
+
const globalDirect = config.settings?.directTools;
|
|
123
|
+
const envSelection = envOverride ? parseDirectToolSelectors(envOverride) : null;
|
|
124
|
+
for (const [serverName, definition] of Object.entries(config.mcpServers)) {
|
|
125
|
+
if (isServerDisabled(definition))
|
|
126
|
+
continue;
|
|
127
|
+
const hasDirectTools = envSelection
|
|
128
|
+
? envSelection.servers.has(serverName) || envSelection.tools.has(serverName)
|
|
129
|
+
: definition.directTools !== undefined
|
|
130
|
+
? !!definition.directTools
|
|
131
|
+
: !!globalDirect;
|
|
132
|
+
if (!hasDirectTools)
|
|
133
|
+
continue;
|
|
134
|
+
const serverCache = cache?.servers?.[serverName];
|
|
135
|
+
if (!serverCache || !isServerCacheValid(serverCache, definition)) {
|
|
136
|
+
missing.push(serverName);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
return missing;
|
|
140
|
+
}
|
|
141
|
+
export function reconstructToolMetadata(serverName, entry, prefix, definition) {
|
|
142
|
+
const metadata = [];
|
|
143
|
+
const seenNames = new Set();
|
|
144
|
+
const effectivePrefix = resolveToolPrefix(definition, prefix);
|
|
145
|
+
for (const tool of entry.tools ?? []) {
|
|
146
|
+
if (!tool?.name)
|
|
147
|
+
continue;
|
|
148
|
+
if (!isUiToolVisibleToModel(tool.uiVisibility)) {
|
|
149
|
+
continue;
|
|
150
|
+
}
|
|
151
|
+
if (!isToolAllowed(tool.name, serverName, effectivePrefix, definition.includeTools, definition.excludeTools)) {
|
|
152
|
+
continue;
|
|
153
|
+
}
|
|
154
|
+
const name = formatToolName(tool.name, serverName, effectivePrefix);
|
|
155
|
+
if (seenNames.has(name)) {
|
|
156
|
+
continue;
|
|
157
|
+
}
|
|
158
|
+
seenNames.add(name);
|
|
159
|
+
metadata.push({
|
|
160
|
+
name,
|
|
161
|
+
originalName: tool.name,
|
|
162
|
+
description: tool.description ?? "",
|
|
163
|
+
...(tool.inputSchema !== undefined ? { inputSchema: tool.inputSchema } : {}),
|
|
164
|
+
...(tool.annotations !== undefined ? { annotations: tool.annotations } : {}),
|
|
165
|
+
...(tool.uiResourceUri !== undefined ? { uiResourceUri: tool.uiResourceUri } : {}),
|
|
166
|
+
...(tool.uiVisibility !== undefined ? { uiVisibility: tool.uiVisibility } : {}),
|
|
167
|
+
...(tool.uiStreamMode !== undefined ? { uiStreamMode: tool.uiStreamMode } : {}),
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
if (definition.exposeResources !== false) {
|
|
171
|
+
for (const resource of entry.resources ?? []) {
|
|
172
|
+
if (!resource?.name || !resource?.uri)
|
|
173
|
+
continue;
|
|
174
|
+
const baseName = `read_${resourceNameToToolName(resource.name)}`;
|
|
175
|
+
if (!isToolAllowed(baseName, serverName, effectivePrefix, definition.includeTools, definition.excludeTools)) {
|
|
176
|
+
continue;
|
|
177
|
+
}
|
|
178
|
+
const name = formatToolName(baseName, serverName, effectivePrefix);
|
|
179
|
+
if (seenNames.has(name)) {
|
|
180
|
+
continue;
|
|
181
|
+
}
|
|
182
|
+
seenNames.add(name);
|
|
183
|
+
metadata.push({
|
|
184
|
+
name,
|
|
185
|
+
originalName: baseName,
|
|
186
|
+
description: resource.description ?? `Read resource: ${resource.uri}`,
|
|
187
|
+
resourceUri: resource.uri,
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
return metadata;
|
|
192
|
+
}
|
|
193
|
+
export function serializeTools(tools) {
|
|
194
|
+
return tools
|
|
195
|
+
.filter(t => t?.name)
|
|
196
|
+
.map(t => {
|
|
197
|
+
const uiResourceUri = tryGetToolUiResourceUri(t);
|
|
198
|
+
const uiVisibility = extractUiToolVisibility(t._meta);
|
|
199
|
+
const uiStreamMode = extractToolUiStreamMode(t._meta);
|
|
200
|
+
return {
|
|
201
|
+
name: t.name,
|
|
202
|
+
...(t.description !== undefined ? { description: t.description } : {}),
|
|
203
|
+
...(t.inputSchema !== undefined ? { inputSchema: t.inputSchema } : {}),
|
|
204
|
+
...(t.annotations !== undefined ? { annotations: t.annotations } : {}),
|
|
205
|
+
...(uiResourceUri !== undefined ? { uiResourceUri } : {}),
|
|
206
|
+
...(uiVisibility !== undefined ? { uiVisibility } : {}),
|
|
207
|
+
...(uiStreamMode !== undefined ? { uiStreamMode } : {}),
|
|
208
|
+
};
|
|
209
|
+
});
|
|
210
|
+
}
|
|
211
|
+
export function serializeResources(resources) {
|
|
212
|
+
return resources
|
|
213
|
+
.filter(r => r?.name && r?.uri)
|
|
214
|
+
.map(r => ({
|
|
215
|
+
uri: r.uri,
|
|
216
|
+
name: r.name,
|
|
217
|
+
...(r.description !== undefined ? { description: r.description } : {}),
|
|
218
|
+
}));
|
|
219
|
+
}
|
|
220
|
+
export function serializePrompts(prompts) {
|
|
221
|
+
return (prompts ?? [])
|
|
222
|
+
.filter(prompt => prompt?.name)
|
|
223
|
+
.map(prompt => ({
|
|
224
|
+
name: prompt.name,
|
|
225
|
+
...(prompt.title !== undefined ? { title: prompt.title } : {}),
|
|
226
|
+
...(prompt.description !== undefined ? { description: prompt.description } : {}),
|
|
227
|
+
...(Array.isArray(prompt.arguments)
|
|
228
|
+
? {
|
|
229
|
+
arguments: prompt.arguments.filter(argument => argument?.name).map(argument => ({
|
|
230
|
+
name: argument.name,
|
|
231
|
+
...(argument.description !== undefined ? { description: argument.description } : {}),
|
|
232
|
+
...(argument.required !== undefined ? { required: argument.required } : {}),
|
|
233
|
+
})),
|
|
234
|
+
}
|
|
235
|
+
: {}),
|
|
236
|
+
}));
|
|
237
|
+
}
|
|
238
|
+
export function reconstructPromptMetadata(serverName, prompts, prefix, definition) {
|
|
239
|
+
const effectivePrefix = resolveToolPrefix(definition, prefix);
|
|
240
|
+
return (prompts ?? []).filter(prompt => prompt?.name).map(prompt => {
|
|
241
|
+
const args = Array.isArray(prompt.arguments)
|
|
242
|
+
? prompt.arguments.filter(argument => argument?.name).map(argument => ({
|
|
243
|
+
name: argument.name,
|
|
244
|
+
...(argument.description !== undefined ? { description: argument.description } : {}),
|
|
245
|
+
...(argument.required !== undefined ? { required: argument.required } : {}),
|
|
246
|
+
}))
|
|
247
|
+
: [];
|
|
248
|
+
return {
|
|
249
|
+
serverName,
|
|
250
|
+
originalName: prompt.name,
|
|
251
|
+
commandName: formatPromptCommandName(prompt.name, serverName, effectivePrefix),
|
|
252
|
+
...(prompt.title !== undefined ? { title: prompt.title } : {}),
|
|
253
|
+
description: prompt.description ?? "",
|
|
254
|
+
arguments: args,
|
|
255
|
+
};
|
|
256
|
+
});
|
|
257
|
+
}
|
|
258
|
+
function stableStringify(value) {
|
|
259
|
+
if (value === null || value === undefined || typeof value !== "object") {
|
|
260
|
+
const serialized = JSON.stringify(value);
|
|
261
|
+
return serialized === undefined ? "undefined" : serialized;
|
|
262
|
+
}
|
|
263
|
+
if (Array.isArray(value)) {
|
|
264
|
+
return `[${value.map(v => stableStringify(v)).join(",")}]`;
|
|
265
|
+
}
|
|
266
|
+
const obj = value;
|
|
267
|
+
const keys = Object.keys(obj).sort();
|
|
268
|
+
return `{${keys.map(k => `${JSON.stringify(k)}:${stableStringify(obj[k])}`).join(",")}}`;
|
|
269
|
+
}
|
|
270
|
+
function tryGetToolUiResourceUri(tool) {
|
|
271
|
+
try {
|
|
272
|
+
return getToolUiResourceUri({ _meta: tool._meta });
|
|
273
|
+
}
|
|
274
|
+
catch {
|
|
275
|
+
return undefined;
|
|
276
|
+
}
|
|
277
|
+
}
|