@bitkyc08/opencodex 2.6.17 → 2.6.18

package/src/adapters/cursor/mcp-config.ts

@@ -0,0 +1,42 @@
+import type { OcxProviderConfig } from "../../types";
+
+/**
+ * One MCP server opencodex starts/connects and exposes to the Cursor agent as callable tools.
+ * Either `command` (stdio: opencodex spawns the server as a child process) or `url`
+ * (streamable-http: opencodex connects to a remote MCP server) must be set.
+ */
+export interface CursorMcpServerConfig {
+  /** stdio: executable to spawn (e.g. "npx", "node", "uvx"). */
+  command?: string;
+  /** stdio: arguments for the spawned command. */
+  args?: string[];
+  /** stdio: extra environment variables for the child process. */
+  env?: Record<string, string>;
+  /** stdio: working directory for the child process. */
+  cwd?: string;
+  /** streamable-http: remote MCP server URL (alternative to `command`). */
+  url?: string;
+  /** streamable-http: extra headers for the remote connection. */
+  headers?: Record<string, string>;
+  /** Set false to keep the server in config but not connect. Default true. */
+  enabled?: boolean;
+  /** Optional namespace prepended to advertised tool names to avoid collisions. */
+  toolPrefix?: string;
+}
+
+export interface ResolvedMcpServer extends CursorMcpServerConfig {
+  serverName: string;
+}
+
+/**
+ * Resolve the enabled, connectable MCP servers from a provider config. A server is
+ * connectable only if it declares either a `command` (stdio) or a `url` (http).
+ */
+export function resolveMcpServers(provider: OcxProviderConfig): ResolvedMcpServer[] {
+  const raw = provider.mcpServers;
+  if (!raw) return [];
+  return Object.entries(raw)
+    .map(([serverName, cfg]) => ({ serverName, ...cfg }))
+    .filter(server => server.enabled !== false)
+    .filter(server => Boolean(server.command || server.url));
+}

package/src/adapters/cursor/mcp-manager.ts

@@ -0,0 +1,236 @@
+import { Client } from "@modelcontextprotocol/sdk/client/index.js";
+import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
+import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
+import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
+import type { ResolvedMcpServer } from "./mcp-config";
+
+const DEFAULT_CONNECT_TIMEOUT_MS = 15_000;
+const DEFAULT_CALL_TIMEOUT_MS = 120_000;
+
+/** A tool discovered on a connected MCP server, with its opencodex-advertised name. */
+export interface McpToolHandle {
+  serverName: string;
+  toolName: string;
+  /** Name advertised to the Cursor agent (toolPrefix applied). */
+  advertisedName: string;
+  description: string;
+  inputSchema: unknown;
+}
+
+/** Normalized MCP tool-call result (SDK-shape-agnostic). */
+export interface McpCallResult {
+  isError: boolean;
+  content: Array<{ type: string; text?: string; data?: string; mimeType?: string }>;
+}
+
+export interface McpResourceListing {
+  uri: string;
+  name?: string;
+  description?: string;
+  mimeType?: string;
+  server: string;
+}
+
+export interface McpResourceContent {
+  uri: string;
+  mimeType?: string;
+  text?: string;
+  blob?: Uint8Array;
+}
+
+export interface CursorMcpManagerOptions {
+  connectTimeoutMs?: number;
+  callTimeoutMs?: number;
+  /** Test seam: provide a transport factory instead of spawning real processes. */
+  transportFactory?: (server: ResolvedMcpServer) => Transport;
+  log?: (message: string) => void;
+}
+
+interface ConnectedServer {
+  server: ResolvedMcpServer;
+  client: Client;
+}
+
+/**
+ * Owns the lifecycle of MCP client connections for one Cursor stream. Lazily connects to the
+ * configured servers, discovers their tools/resources, and executes tool/resource calls.
+ *
+ * Connection failures are isolated per-server: one unreachable server never blocks the others
+ * and never throws out of `ensureConnected`. Tool-level errors from a server resolve as
+ * `{ isError: true }` (they do not throw); only protocol/transport failures throw from
+ * `callTool`/`listResources`/`readResource`, and callers are expected to map those to typed
+ * protobuf error results.
+ */
+export class CursorMcpManager {
+  private readonly connectTimeoutMs: number;
+  private readonly callTimeoutMs: number;
+  private connected?: Promise<void>;
+  private readonly servers = new Map<string, ConnectedServer>();
+  /** advertisedName -> { serverName, original toolName } */
+  private readonly toolIndex = new Map<string, { serverName: string; toolName: string; handle: McpToolHandle }>();
+
+  constructor(
+    private readonly resolved: ResolvedMcpServer[],
+    private readonly options: CursorMcpManagerOptions = {},
+  ) {
+    this.connectTimeoutMs = options.connectTimeoutMs ?? DEFAULT_CONNECT_TIMEOUT_MS;
+    this.callTimeoutMs = options.callTimeoutMs ?? DEFAULT_CALL_TIMEOUT_MS;
+  }
+
+  /** Idempotent, lazy connect + tool discovery across all servers. Never throws. */
+  ensureConnected(): Promise<void> {
+    if (!this.connected) this.connected = this.connectAll();
+    return this.connected;
+  }
+
+  private async connectAll(): Promise<void> {
+    await Promise.all(this.resolved.map(server => this.connectOne(server)));
+  }
+
+  private async connectOne(server: ResolvedMcpServer): Promise<void> {
+    try {
+      const transport = this.options.transportFactory
+        ? this.options.transportFactory(server)
+        : this.createTransport(server);
+      const client = new Client({ name: "opencodex", version: "1.0.0" });
+      await this.withTimeout(client.connect(transport), this.connectTimeoutMs, `connect ${server.serverName}`);
+      this.servers.set(server.serverName, { server, client });
+      await this.indexTools(server, client);
+    } catch (err) {
+      this.options.log?.(`[cursor-mcp] server "${server.serverName}" failed to connect: ${errText(err)}`);
+    }
+  }
+
+  private createTransport(server: ResolvedMcpServer): Transport {
+    if (server.command) {
+      return new StdioClientTransport({
+        command: server.command,
+        args: server.args ?? [],
+        env: server.env,
+        cwd: server.cwd,
+      });
+    }
+    if (server.url) {
+      return new StreamableHTTPClientTransport(new URL(server.url), {
+        requestInit: server.headers ? { headers: server.headers } : undefined,
+      });
+    }
+    throw new Error(`MCP server "${server.serverName}" has neither command nor url`);
+  }
+
+  private async indexTools(server: ResolvedMcpServer, client: Client): Promise<void> {
+    const prefix = server.toolPrefix ?? "";
+    const { tools } = await this.withTimeout(client.listTools(), this.connectTimeoutMs, `listTools ${server.serverName}`);
+    for (const tool of tools ?? []) {
+      const advertisedName = `${prefix}${tool.name}`;
+      const handle: McpToolHandle = {
+        serverName: server.serverName,
+        toolName: tool.name,
+        advertisedName,
+        description: tool.description ?? "",
+        inputSchema: tool.inputSchema ?? {},
+      };
+      this.toolIndex.set(advertisedName, { serverName: server.serverName, toolName: tool.name, handle });
+    }
+  }
+
+  async listToolHandles(): Promise<McpToolHandle[]> {
+    await this.ensureConnected();
+    return [...this.toolIndex.values()].map(entry => entry.handle);
+  }
+
+  async resolveTool(advertisedName: string): Promise<McpToolHandle | undefined> {
+    await this.ensureConnected();
+    return this.toolIndex.get(advertisedName)?.handle;
+  }
+
+  async toolNames(): Promise<string[]> {
+    await this.ensureConnected();
+    return [...this.toolIndex.keys()];
+  }
+
+  /** Throws only on protocol/transport failure or unknown tool; tool-level errors resolve. */
+  async callTool(advertisedName: string, args: Record<string, unknown>): Promise<McpCallResult> {
+    await this.ensureConnected();
+    const entry = this.toolIndex.get(advertisedName);
+    if (!entry) throw new Error(`MCP tool not found: ${advertisedName}`);
+    const conn = this.servers.get(entry.serverName);
+    if (!conn) throw new Error(`MCP server not connected: ${entry.serverName}`);
+    const result = await this.withTimeout(
+      conn.client.callTool({ name: entry.toolName, arguments: args }),
+      this.callTimeoutMs,
+      `callTool ${advertisedName}`,
+    );
+    return {
+      isError: Boolean((result as { isError?: boolean }).isError),
+      content: normalizeContent((result as { content?: unknown[] }).content),
+    };
+  }
+
+  async listResources(server?: string): Promise<McpResourceListing[]> {
+    await this.ensureConnected();
+    const targets = server ? [this.servers.get(server)].filter(Boolean) as ConnectedServer[] : [...this.servers.values()];
+    const out: McpResourceListing[] = [];
+    for (const conn of targets) {
+      const { resources } = await this.withTimeout(conn.client.listResources(), this.callTimeoutMs, `listResources ${conn.server.serverName}`);
+      for (const r of resources ?? []) {
+        out.push({ uri: r.uri, name: r.name, description: r.description, mimeType: r.mimeType, server: conn.server.serverName });
+      }
+    }
+    return out;
+  }
+
+  async readResource(server: string, uri: string): Promise<McpResourceContent> {
+    await this.ensureConnected();
+    const conn = this.servers.get(server);
+    if (!conn) throw new Error(`MCP server not connected: ${server}`);
+    const result = await this.withTimeout(conn.client.readResource({ uri }), this.callTimeoutMs, `readResource ${uri}`);
+    const first = (result.contents ?? [])[0] as { uri?: string; mimeType?: string; text?: string; blob?: string } | undefined;
+    if (!first) return { uri, mimeType: undefined, text: "" };
+    return {
+      uri: first.uri ?? uri,
+      mimeType: first.mimeType,
+      text: typeof first.text === "string" ? first.text : undefined,
+      blob: typeof first.blob === "string" ? Uint8Array.from(Buffer.from(first.blob, "base64")) : undefined,
+    };
+  }
+
+  async dispose(): Promise<void> {
+    const conns = [...this.servers.values()];
+    this.servers.clear();
+    this.toolIndex.clear();
+    await Promise.all(conns.map(async conn => {
+      try {
+        await conn.client.close();
+      } catch (err) {
+        this.options.log?.(`[cursor-mcp] dispose "${conn.server.serverName}": ${errText(err)}`);
+      }
+    }));
+  }
+
+  private async withTimeout<T>(promise: Promise<T>, ms: number, label: string): Promise<T> {
+    let timer: ReturnType<typeof setTimeout> | undefined;
+    try {
+      return await Promise.race([
+        promise,
+        new Promise<never>((_, reject) => {
+          timer = setTimeout(() => reject(new Error(`MCP ${label} timed out after ${ms}ms`)), ms);
+        }),
+      ]);
+    } finally {
+      if (timer) clearTimeout(timer);
+    }
+  }
+}
+
+function normalizeContent(content: unknown[] | undefined): McpCallResult["content"] {
+  if (!Array.isArray(content)) return [];
+  return content.map(item => {
+    const block = item as { type?: string; text?: string; data?: string; mimeType?: string };
+    return { type: block.type ?? "text", text: block.text, data: block.data, mimeType: block.mimeType };
+  });
+}
+
+function errText(err: unknown): string {
+  return err instanceof Error ? err.message : String(err);
+}

package/src/adapters/cursor/message-mapper.ts

@@ -0,0 +1,46 @@
+import type { AdapterEvent } from "../../types";
+import { cursorExecResult } from "./exec-policy";
+import type { CursorClientMessage, CursorServerMessage } from "./types";
+import type { CursorKvStore } from "./kv-store";
+
+export interface CursorMessageMapperState {
+  kv: CursorKvStore;
+  writeClient(message: CursorClientMessage): void;
+}
+
+export function mapCursorServerMessage(
+  message: CursorServerMessage,
+  state: CursorMessageMapperState,
+): AdapterEvent[] {
+  switch (message.type) {
+    case "text":
+      return [{ type: "text_delta", text: message.text }];
+    case "thinking":
+      return [{ type: "thinking_delta", thinking: message.thinking }];
+    case "tool_call_start":
+      return [{ type: "tool_call_start", id: message.id, name: message.name }];
+    case "tool_call_delta":
+      return [{ type: "tool_call_delta", arguments: message.arguments }];
+    case "tool_call_end":
+      return [{ type: "tool_call_end" }];
+    case "done":
+      return [{ type: "done", usage: message.usage }];
+    case "error":
+      return [{ type: "error", message: message.message, ...(message.usage ? { usage: message.usage } : {}) }];
+    case "heartbeat":
+      // Liveness only: keeps the bridge's stall watchdog from tripping upstream_stall_timeout while
+      // Cursor silently assembles (parallel) tool calls. The bridge resets stallTicks on any adapter
+      // event and ignores unknown event types, so this emits no Responses protocol event.
+      return [{ type: "heartbeat" }];
+    case "kv_get":
+      state.writeClient({ type: "kv_value", key: message.key, value: state.kv.get(message.key) });
+      return [];
+    case "kv_set":
+      state.kv.set(message.key, message.value);
+      state.writeClient({ type: "kv_stored", key: message.key });
+      return [];
+    case "exec":
+      state.writeClient(cursorExecResult(message.requestId, message.execCase));
+      return [];
+  }
+}

package/src/adapters/cursor/native-exec-common.ts

@@ -0,0 +1,55 @@
+import { create, toBinary } from "@bufbuild/protobuf";
+import {
+  AgentClientMessageSchema,
+  ExecClientControlMessageSchema,
+  ExecClientMessageSchema,
+  ExecClientStreamCloseSchema,
+  type ExecClientMessage,
+  type ExecServerMessage,
+} from "./gen/agent_pb";
+
+export const textDecoder = new TextDecoder();
+export const textEncoder = new TextEncoder();
+
+export function clientBytes(message: Parameters<typeof create<typeof AgentClientMessageSchema>>[1]): Uint8Array {
+  return toBinary(AgentClientMessageSchema, create(AgentClientMessageSchema, message));
+}
+
+export function execBytes(execMsg: ExecServerMessage, messageCase: ExecClientMessage["message"]["case"], value: unknown): Uint8Array {
+  return clientBytes({
+    message: {
+      case: "execClientMessage",
+      value: create(ExecClientMessageSchema, {
+        id: execMsg.id,
+        execId: execMsg.execId,
+        message: { case: messageCase, value: value as never },
+      }),
+    },
+  });
+}
+
+/**
+ * Exec-channel stream close acknowledgement (`execClientControlMessage.streamClose`). Cursor keeps
+ * a streamed exec (e.g. `shellStreamArgs`) — and with it the whole turn — pending until the client
+ * closes the exec stream; stream deltas and even the `exit` event alone are not treated as
+ * completion. Mirrors jawcode `sendExecClientStreamClose`.
+ */
+export function execStreamCloseBytes(execMsg: ExecServerMessage): Uint8Array {
+  return clientBytes({
+    message: {
+      case: "execClientControlMessage",
+      value: create(ExecClientControlMessageSchema, {
+        message: { case: "streamClose", value: create(ExecClientStreamCloseSchema, { id: execMsg.id }) },
+      }),
+    },
+  });
+}
+
+export function errorText(err: unknown): string {
+  return err instanceof Error ? err.message : String(err);
+}
+
+export function lineCount(text: string): number {
+  if (text.length === 0) return 0;
+  return text.split(/\r\n|\r|\n/).length;
+}

package/src/adapters/cursor/native-exec-desktop.ts

@@ -0,0 +1,177 @@
+import { spawn } from "node:child_process";
+import { create } from "@bufbuild/protobuf";
+import {
+  ComputerUseErrorSchema,
+  ComputerUseResultSchema,
+  ComputerUseSuccessSchema,
+  RecordScreenDiscardSuccessSchema,
+  RecordScreenFailureSchema,
+  RecordScreenResultSchema,
+  RecordScreenSaveSuccessSchema,
+  RecordScreenStartSuccessSchema,
+  type ComputerUseArgs,
+  type ComputerUseResult,
+  type RecordScreenArgs,
+  type RecordScreenResult,
+} from "./gen/agent_pb";
+import { errorText } from "./native-exec-common";
+import type { CursorNativeToolDeps } from "./native-exec-tools";
+
+const DEFAULT_DESKTOP_TIMEOUT_MS = 30_000;
+
+/**
+ * Opt-in external executor for computer-use / record-screen. opencodex is a headless proxy and
+ * cannot drive a screen itself; set these commands only when running on a host that can. Each
+ * command receives the request as JSON on stdin and must print a JSON result on stdout.
+ */
+export interface DesktopExecutorConfig {
+  /** Command (run via `sh -c`) handling computer-use. Receives `{toolCallId, actions}` on stdin. */
+  computerUseCommand?: string;
+  /** Command handling record-screen. Receives `{mode, toolCallId, saveAsFilename?}` on stdin. */
+  recordScreenCommand?: string;
+  cwd?: string;
+  env?: Record<string, string>;
+  /** Max time to wait for the external process. Default 30s. */
+  timeoutMs?: number;
+}
+
+/**
+ * Build `computerUse` / `recordScreen` deps from external executor commands. Returns `{}` when no
+ * command is configured (the dispatcher then falls back to the honest "not supported" default).
+ * Every method maps results to protobuf and NEVER throws — a throw would propagate into the
+ * stream loop and fail the conversation.
+ */
+export function desktopDepsFromConfig(config?: DesktopExecutorConfig): CursorNativeToolDeps {
+  if (!config?.computerUseCommand && !config?.recordScreenCommand) return {};
+  const deps: CursorNativeToolDeps = {};
+  if (config.computerUseCommand) {
+    deps.computerUse = (args: ComputerUseArgs) => runComputerUse(config, args);
+  }
+  if (config.recordScreenCommand) {
+    deps.recordScreen = (args: RecordScreenArgs) => runRecordScreen(config, args);
+  }
+  return deps;
+}
+
+async function runComputerUse(config: DesktopExecutorConfig, args: ComputerUseArgs): Promise<ComputerUseResult> {
+  const actionCount = args.actions.length;
+  try {
+    const out = await runExternalJson(config.computerUseCommand!, {
+      toolCallId: args.toolCallId,
+      actions: args.actions,
+    }, config);
+    if (out && typeof out === "object" && "error" in out) {
+      return computerUseError(String((out as { error: unknown }).error), actionCount);
+    }
+    const result = out as { screenshot?: string; screenshotPath?: string; durationMs?: number; log?: string };
+    return create(ComputerUseResultSchema, {
+      result: { case: "success", value: create(ComputerUseSuccessSchema, {
+        actionCount,
+        durationMs: typeof result?.durationMs === "number" ? result.durationMs : 0,
+        screenshot: result?.screenshot,
+        screenshotPath: result?.screenshotPath,
+        log: result?.log,
+      }) },
+    });
+  } catch (err) {
+    return computerUseError(errorText(err), actionCount);
+  }
+}
+
+async function runRecordScreen(config: DesktopExecutorConfig, args: RecordScreenArgs): Promise<RecordScreenResult> {
+  try {
+    const out = await runExternalJson(config.recordScreenCommand!, {
+      mode: args.mode,
+      toolCallId: args.toolCallId,
+      saveAsFilename: args.saveAsFilename,
+    }, config) as Record<string, unknown>;
+    if (out?.startSuccess) {
+      const s = out.startSuccess as { wasPriorRecordingCancelled?: boolean; wasSaveAsFilenameIgnored?: boolean };
+      return create(RecordScreenResultSchema, { result: { case: "startSuccess", value: create(RecordScreenStartSuccessSchema, {
+        wasPriorRecordingCancelled: Boolean(s.wasPriorRecordingCancelled),
+        wasSaveAsFilenameIgnored: Boolean(s.wasSaveAsFilenameIgnored),
+      }) } });
+    }
+    if (out?.saveSuccess) {
+      const s = out.saveSuccess as { path?: string; recordingDurationMs?: number };
+      return create(RecordScreenResultSchema, { result: { case: "saveSuccess", value: create(RecordScreenSaveSuccessSchema, {
+        path: String(s.path ?? ""),
+        recordingDurationMs: BigInt(Math.trunc(s.recordingDurationMs ?? 0)),
+      }) } });
+    }
+    if (out?.discardSuccess) {
+      return create(RecordScreenResultSchema, { result: { case: "discardSuccess", value: create(RecordScreenDiscardSuccessSchema, {}) } });
+    }
+    const failure = out?.failure as { error?: unknown } | undefined;
+    return recordScreenFailure(failure?.error ? String(failure.error) : "record-screen executor returned no recognized result");
+  } catch (err) {
+    return recordScreenFailure(errorText(err));
+  }
+}
+
+function computerUseError(error: string, actionCount: number): ComputerUseResult {
+  return create(ComputerUseResultSchema, {
+    result: { case: "error", value: create(ComputerUseErrorSchema, { error, actionCount, durationMs: 0 }) },
+  });
+}
+
+function recordScreenFailure(error: string): RecordScreenResult {
+  return create(RecordScreenResultSchema, {
+    result: { case: "failure", value: create(RecordScreenFailureSchema, { error }) },
+  });
+}
+
+/** Spawn `command` via the shell, write `payload` as JSON to stdin, return parsed stdout JSON. */
+function runExternalJson(command: string, payload: unknown, config: DesktopExecutorConfig): Promise<unknown> {
+  const timeoutMs = config.timeoutMs ?? DEFAULT_DESKTOP_TIMEOUT_MS;
+  return new Promise((resolve, reject) => {
+    const child = spawn("sh", ["-c", command], {
+      cwd: config.cwd,
+      env: config.env ? { ...process.env, ...config.env } : process.env,
+      stdio: ["pipe", "pipe", "pipe"],
+    });
+    let stdout = "";
+    let stderr = "";
+    let settled = false;
+    const timer = setTimeout(() => {
+      if (settled) return;
+      settled = true;
+      child.kill("SIGKILL");
+      reject(new Error(`desktop executor timed out after ${timeoutMs}ms`));
+    }, timeoutMs);
+
+    child.stdout.on("data", chunk => { stdout += chunk.toString(); });
+    child.stderr.on("data", chunk => { stderr += chunk.toString(); });
+    child.on("error", err => {
+      if (settled) return;
+      settled = true;
+      clearTimeout(timer);
+      reject(err);
+    });
+    child.on("close", code => {
+      if (settled) return;
+      settled = true;
+      clearTimeout(timer);
+      if (code !== 0) {
+        reject(new Error(`desktop executor exited with code ${code}${stderr ? `: ${stderr.trim()}` : ""}`));
+        return;
+      }
+      try {
+        resolve(JSON.parse(stdout.trim()));
+      } catch {
+        reject(new Error(`desktop executor produced invalid JSON: ${stdout.slice(0, 200)}`));
+      }
+    });
+
+    try {
+      child.stdin.write(JSON.stringify(payload));
+      child.stdin.end();
+    } catch (err) {
+      if (!settled) {
+        settled = true;
+        clearTimeout(timer);
+        reject(err);
+      }
+    }
+  });
+}