ai 0.0.0-85f9a635-20240518005312 → 0.0.0-9477ebb9-20250403064906

package/mcp-stdio/create-child-process.test.ts

@@ -0,0 +1,92 @@
+import { beforeEach, vi } from 'vitest';
+import * as getEnvironmentModule from './get-environment';
+
+const DEFAULT_ENV = {
+  PATH: 'path',
+};
+
+const mockGetEnvironment = vi
+  .fn()
+  .mockImplementation((customEnv?: Record<string, string>) => {
+    return {
+      ...DEFAULT_ENV,
+      ...customEnv,
+    };
+  });
+vi.spyOn(getEnvironmentModule, 'getEnvironment').mockImplementation(
+  mockGetEnvironment,
+);
+
+// important: import after mocking getEnv
+const { createChildProcess } = await import('./create-child-process');
+
+describe('createChildProcess', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should spawn a child process', async () => {
+    const childProcess = await createChildProcess(
+      { command: process.execPath },
+      new AbortController().signal,
+    );
+
+    expect(childProcess.pid).toBeDefined();
+    expect(mockGetEnvironment).toHaveBeenCalledWith(undefined);
+    childProcess.kill();
+  });
+
+  it('should spawn a child process with custom env', async () => {
+    const customEnv = { FOO: 'bar' };
+    const childProcessWithCustomEnv = await createChildProcess(
+      { command: process.execPath, env: customEnv },
+      new AbortController().signal,
+    );
+
+    expect(childProcessWithCustomEnv.pid).toBeDefined();
+    expect(mockGetEnvironment).toHaveBeenCalledWith(customEnv);
+    expect(mockGetEnvironment).toHaveReturnedWith({
+      ...DEFAULT_ENV,
+      ...customEnv,
+    });
+    childProcessWithCustomEnv.kill();
+  });
+
+  it('should spawn a child process with args', async () => {
+    const childProcessWithArgs = await createChildProcess(
+      { command: process.execPath, args: ['-c', 'echo', 'test'] },
+      new AbortController().signal,
+    );
+
+    expect(childProcessWithArgs.pid).toBeDefined();
+    expect(childProcessWithArgs.spawnargs).toContain(process.execPath);
+    expect(childProcessWithArgs.spawnargs).toEqual([
+      process.execPath,
+      '-c',
+      'echo',
+      'test',
+    ]);
+    childProcessWithArgs.kill();
+  });
+
+  it('should spawn a child process with cwd', async () => {
+    const childProcessWithCwd = await createChildProcess(
+      { command: process.execPath, cwd: '/tmp' },
+      new AbortController().signal,
+    );
+
+    expect(childProcessWithCwd.pid).toBeDefined();
+    childProcessWithCwd.kill();
+  });
+
+  it('should spawn a child process with stderr', async () => {
+    const childProcessWithStderr = await createChildProcess(
+      { command: process.execPath, stderr: 'pipe' },
+      new AbortController().signal,
+    );
+
+    expect(childProcessWithStderr.pid).toBeDefined();
+    expect(childProcessWithStderr.stderr).toBeDefined();
+    childProcessWithStderr.kill();
+  });
+});

package/mcp-stdio/create-child-process.ts

@@ -0,0 +1,21 @@
+import { ChildProcess, spawn } from 'node:child_process';
+import { getEnvironment } from './get-environment';
+import { StdioConfig } from './mcp-stdio-transport';
+
+export async function createChildProcess(
+  config: StdioConfig,
+  signal: AbortSignal,
+): Promise<ChildProcess> {
+  return spawn(config.command, config.args ?? [], {
+    env: getEnvironment(config.env),
+    stdio: ['pipe', 'pipe', config.stderr ?? 'inherit'],
+    shell: false,
+    signal,
+    windowsHide: globalThis.process.platform === 'win32' && isElectron(),
+    cwd: config.cwd,
+  });
+}
+
+function isElectron() {
+  return 'type' in globalThis.process;
+}

package/mcp-stdio/dist/index.d.mts

@@ -0,0 +1,169 @@
+import { IOType } from 'node:child_process';
+import { Stream } from 'node:stream';
+import { z } from 'zod';
+
+declare const JSONRPCMessageSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, {
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}>, "strict", z.ZodTypeAny, {
+    method: string;
+    jsonrpc: "2.0";
+    id: string | number;
+    params?: z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    method: string;
+    jsonrpc: "2.0";
+    id: string | number;
+    params?: z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+}, {
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}>, "strict", z.ZodTypeAny, {
+    method: string;
+    jsonrpc: "2.0";
+    params?: z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    method: string;
+    jsonrpc: "2.0";
+    params?: z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}>, z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    result: z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strict", z.ZodTypeAny, {
+    result: {
+        _meta?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}, {
+    result: {
+        _meta?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}>, z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    error: z.ZodObject<{
+        code: z.ZodNumber;
+        message: z.ZodString;
+        data: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        code: number;
+        message: string;
+        data?: unknown;
+    }, {
+        code: number;
+        message: string;
+        data?: unknown;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}, {
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}>]>;
+type JSONRPCMessage = z.infer<typeof JSONRPCMessageSchema>;
+
+/**
+ * Transport interface for MCP (Model Context Protocol) communication.
+ * Maps to the `Transport` interface in the MCP spec.
+ */
+interface MCPTransport {
+    /**
+     * Initialize and start the transport
+     */
+    start(): Promise<void>;
+    /**
+     * Send a JSON-RPC message through the transport
+     * @param message The JSON-RPC message to send
+     */
+    send(message: JSONRPCMessage): Promise<void>;
+    /**
+     * Clean up and close the transport
+     */
+    close(): Promise<void>;
+    /**
+     * Event handler for transport closure
+     */
+    onclose?: () => void;
+    /**
+     * Event handler for transport errors
+     */
+    onerror?: (error: Error) => void;
+    /**
+     * Event handler for received messages
+     */
+    onmessage?: (message: JSONRPCMessage) => void;
+}
+
+interface StdioConfig {
+    command: string;
+    args?: string[];
+    env?: Record<string, string>;
+    stderr?: IOType | Stream | number;
+    cwd?: string;
+}
+declare class StdioMCPTransport implements MCPTransport {
+    private process?;
+    private abortController;
+    private readBuffer;
+    private serverParams;
+    onclose?: () => void;
+    onerror?: (error: unknown) => void;
+    onmessage?: (message: JSONRPCMessage) => void;
+    constructor(server: StdioConfig);
+    start(): Promise<void>;
+    private processReadBuffer;
+    close(): Promise<void>;
+    send(message: JSONRPCMessage): Promise<void>;
+}
+
+export { StdioMCPTransport as Experimental_StdioMCPTransport, StdioConfig };

package/mcp-stdio/dist/index.d.ts

@@ -0,0 +1,169 @@
+import { IOType } from 'node:child_process';
+import { Stream } from 'node:stream';
+import { z } from 'zod';
+
+declare const JSONRPCMessageSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, {
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}>, "strict", z.ZodTypeAny, {
+    method: string;
+    jsonrpc: "2.0";
+    id: string | number;
+    params?: z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    method: string;
+    jsonrpc: "2.0";
+    id: string | number;
+    params?: z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+}, {
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}>, "strict", z.ZodTypeAny, {
+    method: string;
+    jsonrpc: "2.0";
+    params?: z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    method: string;
+    jsonrpc: "2.0";
+    params?: z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}>, z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    result: z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        _meta: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strict", z.ZodTypeAny, {
+    result: {
+        _meta?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}, {
+    result: {
+        _meta?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}>, z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    error: z.ZodObject<{
+        code: z.ZodNumber;
+        message: z.ZodString;
+        data: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        code: number;
+        message: string;
+        data?: unknown;
+    }, {
+        code: number;
+        message: string;
+        data?: unknown;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}, {
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+    jsonrpc: "2.0";
+    id: string | number;
+}>]>;
+type JSONRPCMessage = z.infer<typeof JSONRPCMessageSchema>;
+
+/**
+ * Transport interface for MCP (Model Context Protocol) communication.
+ * Maps to the `Transport` interface in the MCP spec.
+ */
+interface MCPTransport {
+    /**
+     * Initialize and start the transport
+     */
+    start(): Promise<void>;
+    /**
+     * Send a JSON-RPC message through the transport
+     * @param message The JSON-RPC message to send
+     */
+    send(message: JSONRPCMessage): Promise<void>;
+    /**
+     * Clean up and close the transport
+     */
+    close(): Promise<void>;
+    /**
+     * Event handler for transport closure
+     */
+    onclose?: () => void;
+    /**
+     * Event handler for transport errors
+     */
+    onerror?: (error: Error) => void;
+    /**
+     * Event handler for received messages
+     */
+    onmessage?: (message: JSONRPCMessage) => void;
+}
+
+interface StdioConfig {
+    command: string;
+    args?: string[];
+    env?: Record<string, string>;
+    stderr?: IOType | Stream | number;
+    cwd?: string;
+}
+declare class StdioMCPTransport implements MCPTransport {
+    private process?;
+    private abortController;
+    private readBuffer;
+    private serverParams;
+    onclose?: () => void;
+    onerror?: (error: unknown) => void;
+    onmessage?: (message: JSONRPCMessage) => void;
+    constructor(server: StdioConfig);
+    start(): Promise<void>;
+    private processReadBuffer;
+    close(): Promise<void>;
+    send(message: JSONRPCMessage): Promise<void>;
+}
+
+export { StdioMCPTransport as Experimental_StdioMCPTransport, StdioConfig };