codex-plugin-doctor 0.2.1 → 0.3.0

package/README.md

@@ -162,6 +162,9 @@ codex-plugin-doctor compat . --client codex
 codex-plugin-doctor compat . --client generic-mcp
 codex-plugin-doctor compat . --client claude-desktop
 codex-plugin-doctor compat . --client claude-desktop --install-preview
+codex-plugin-doctor compat . --client cursor
+codex-plugin-doctor compat . --client cursor --install-preview
+codex-plugin-doctor compat . --scorecard
 codex-plugin-doctor compat . --json
 codex-plugin-doctor compat . --json --output compatibility.json
 codex-plugin-doctor check .
@@ -178,6 +181,10 @@ codex-plugin-doctor check . --json --runtime --verbose-runtime
 
 `compat --client claude-desktop` checks whether the MCP package can be added to the local Claude Desktop setup. On Windows it looks for `%APPDATA%\Claude\claude_desktop_config.json`; on macOS it looks for `~/Library/Application Support/Claude/claude_desktop_config.json`. A valid existing config returns `PASS`, a missing Claude Desktop install returns `WARN`, and a malformed local config returns `FAIL` so you do not add new servers into a broken config file. If the package server name already exists in Claude Desktop, the command returns `WARN` with the duplicate server name. Add `--install-preview` to print the JSON snippet that should be merged into `claude_desktop_config.json`; it does not modify files.
 
+`compat --client cursor` checks whether the MCP package can be added to Cursor. It prefers a project-level `.cursor/mcp.json` when one already exists in the target package, then falls back to the global `~/.cursor/mcp.json` path. A valid existing config returns `PASS`, a missing Cursor config returns `WARN`, malformed JSON returns `FAIL`, and duplicate MCP server names return `WARN`. Add `--install-preview` to print the JSON snippet that should be merged into Cursor's `mcp.json`; it does not modify files.
+
+`compat --scorecard` turns the compatibility matrix into a compact score summary. `PASS` maps to `100`, `WARN` maps to `70`, and `FAIL` or `SKIPPED` maps to `0`.
+
 Optional local policy file:
 
 ```json

package/dist/compatibility/compatibility-matrix.d.ts

@@ -16,5 +16,6 @@ export interface CompatibilityEnvironment {
 }
 export declare function readMcpConfigPath(targetPath: string): Promise<string | null>;
 export declare function getClaudeDesktopConfigPath(environment?: CompatibilityEnvironment): string | null;
+export declare function getCursorMcpConfigPath(targetPath: string, environment?: CompatibilityEnvironment): Promise<string>;
 export declare function buildCompatibilityMatrix(targetPath: string, environment?: CompatibilityEnvironment): Promise<CompatibilityMatrix>;
 export declare function matrixExitCode(matrix: CompatibilityMatrix): 0 | 1;

package/dist/compatibility/compatibility-matrix.js

@@ -121,6 +121,18 @@ export function getClaudeDesktopConfigPath(environment = {}) {
     }
     return null;
 }
+function getHomeDirectory(environment = {}) {
+    const env = environment.env ?? process.env;
+    return env.USERPROFILE ?? env.HOME ?? environment.homedir ?? os.homedir();
+}
+export async function getCursorMcpConfigPath(targetPath, environment = {}) {
+    const rootPath = path.resolve(targetPath);
+    const projectConfigPath = path.join(rootPath, ".cursor", "mcp.json");
+    if (await fileExists(projectConfigPath)) {
+        return projectConfigPath;
+    }
+    return path.join(getHomeDirectory(environment), ".cursor", "mcp.json");
+}
 async function checkClaudeDesktop(targetPath, genericMcpResult, environment = {}) {
     if (genericMcpResult.status !== "pass") {
         return {
@@ -201,10 +213,83 @@ async function checkClaudeDesktop(targetPath, genericMcpResult, environment = {}
         };
     }
 }
+async function checkCursor(targetPath, genericMcpResult, environment = {}) {
+    if (genericMcpResult.status !== "pass") {
+        return {
+            client: "Cursor",
+            status: "skipped",
+            summary: "No valid MCP package config is available for Cursor.",
+            details: ["Add a valid `.mcp.json` with a non-empty `mcpServers` object first."]
+        };
+    }
+    const configPath = await getCursorMcpConfigPath(targetPath, environment);
+    if (!(await fileExists(configPath))) {
+        const configDirectory = path.dirname(configPath);
+        return {
+            client: "Cursor",
+            status: await directoryExists(configDirectory) ? "pass" : "warn",
+            summary: await directoryExists(configDirectory)
+                ? "Cursor MCP config directory exists and a config file can be created."
+                : "Cursor was not detected on this machine.",
+            details: [
+                configPath,
+                "Cursor supports project `.cursor/mcp.json` and global `~/.cursor/mcp.json` MCP configs."
+            ]
+        };
+    }
+    try {
+        const parsed = JSON.parse(await readFile(configPath, "utf8"));
+        const servers = parsed.mcpServers;
+        if (servers !== undefined && (typeof servers !== "object" ||
+            servers === null ||
+            Array.isArray(servers))) {
+            return {
+                client: "Cursor",
+                status: "fail",
+                summary: "Cursor MCP config has an invalid `mcpServers` shape.",
+                details: [configPath, "`mcpServers` must be an object before this package can be added safely."]
+            };
+        }
+        const packageServerNames = await readMcpServerNames(targetPath);
+        const existingServerNames = typeof servers === "object" && servers !== null
+            ? Object.keys(servers)
+            : [];
+        const duplicateServerNames = packageServerNames.filter((serverName) => existingServerNames.includes(serverName));
+        if (duplicateServerNames.length > 0) {
+            return {
+                client: "Cursor",
+                status: "warn",
+                summary: "Cursor already has MCP server names from this package.",
+                details: [
+                    configPath,
+                    ...duplicateServerNames.map((serverName) => `Duplicate server: ${serverName}`)
+                ]
+            };
+        }
+        return {
+            client: "Cursor",
+            status: "pass",
+            summary: "Cursor global MCP config is valid and this package can be added.",
+            details: [
+                configPath,
+                `Source package: ${path.resolve(targetPath)}`
+            ]
+        };
+    }
+    catch {
+        return {
+            client: "Cursor",
+            status: "fail",
+            summary: "Cursor MCP config is not valid JSON.",
+            details: [configPath, "Repair the local Cursor MCP config before adding new MCP servers."]
+        };
+    }
+}
 export async function buildCompatibilityMatrix(targetPath, environment = {}) {
     const rootPath = path.resolve(targetPath);
     const genericMcpResult = await checkGenericMcp(rootPath);
     const claudeDesktopResult = await checkClaudeDesktop(rootPath, genericMcpResult, environment);
+    const cursorResult = await checkCursor(rootPath, genericMcpResult, environment);
     const codexResult = await validatePlugin(rootPath);
     const codexStatus = statusFromCheckResult(codexResult);
     const codexCompatibility = !await hasCodexManifest(rootPath)
@@ -227,12 +312,7 @@ export async function buildCompatibilityMatrix(targetPath, environment = {}) {
         codexCompatibility,
         genericMcpResult,
         claudeDesktopResult,
-        {
-            client: "Cursor",
-            status: "skipped",
-            summary: "Client-specific package adapter is not implemented yet.",
-            details: ["Planned adapter after generic MCP compatibility is stable."]
-        }
+        cursorResult
     ];
     return {
         targetPath: rootPath,

package/dist/compatibility/cursor-install-preview.d.ts

@@ -0,0 +1,10 @@
+import { type CompatibilityEnvironment } from "./compatibility-matrix.js";
+export interface CursorInstallPreview {
+    targetPath: string;
+    configPath: string;
+    snippet: {
+        mcpServers: Record<string, unknown>;
+    };
+}
+export declare function buildCursorInstallPreview(targetPath: string, environment?: CompatibilityEnvironment): Promise<CursorInstallPreview>;
+export declare function renderCursorInstallPreview(preview: CursorInstallPreview): string;

package/dist/compatibility/cursor-install-preview.js

@@ -0,0 +1,65 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { getCursorMcpConfigPath, readMcpConfigPath } from "./compatibility-matrix.js";
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isRelativeLocalPath(value) {
+    return value.startsWith("./") ||
+        value.startsWith("../") ||
+        value.startsWith(".\\") ||
+        value.startsWith("..\\");
+}
+function normalizeLocalPathArgument(value, rootPath) {
+    return typeof value === "string" && isRelativeLocalPath(value)
+        ? path.resolve(rootPath, value)
+        : value;
+}
+function normalizeServerConfig(serverConfig, rootPath) {
+    if (!isRecord(serverConfig)) {
+        return serverConfig;
+    }
+    const normalized = { ...serverConfig };
+    if (typeof normalized.command === "string" && isRelativeLocalPath(normalized.command)) {
+        normalized.command = path.resolve(rootPath, normalized.command);
+    }
+    if (Array.isArray(normalized.args)) {
+        normalized.args = normalized.args.map((argument) => normalizeLocalPathArgument(argument, rootPath));
+    }
+    return normalized;
+}
+export async function buildCursorInstallPreview(targetPath, environment = {}) {
+    const rootPath = path.resolve(targetPath);
+    const mcpConfigPath = await readMcpConfigPath(rootPath);
+    if (!mcpConfigPath) {
+        throw new Error("No MCP config found for install preview.");
+    }
+    const parsed = JSON.parse(await readFile(mcpConfigPath, "utf8"));
+    const servers = parsed.mcpServers;
+    if (!isRecord(servers) || Object.keys(servers).length === 0) {
+        throw new Error("MCP config does not contain a non-empty `mcpServers` object.");
+    }
+    return {
+        targetPath: rootPath,
+        configPath: await getCursorMcpConfigPath(rootPath, environment),
+        snippet: {
+            mcpServers: Object.fromEntries(Object.entries(servers).map(([serverName, serverConfig]) => [
+                serverName,
+                normalizeServerConfig(serverConfig, rootPath)
+            ]))
+        }
+    };
+}
+export function renderCursorInstallPreview(preview) {
+    return [
+        "Cursor Install Preview",
+        "======================",
+        `Target: ${preview.targetPath}`,
+        `Config: ${preview.configPath}`,
+        "",
+        "Add or merge this snippet into `mcp.json`:",
+        JSON.stringify(preview.snippet, null, 2),
+        "",
+        "No files were modified."
+    ].join("\n");
+}

package/dist/reporting/render-compatibility-scorecard.d.ts

@@ -0,0 +1,2 @@
+import type { CompatibilityMatrix } from "../compatibility/compatibility-matrix.js";
+export declare function renderCompatibilityScorecard(matrix: CompatibilityMatrix): string;

package/dist/reporting/render-compatibility-scorecard.js

@@ -0,0 +1,21 @@
+function scoreForStatus(status) {
+    if (status === "pass") {
+        return 100;
+    }
+    if (status === "warn") {
+        return 70;
+    }
+    return 0;
+}
+export function renderCompatibilityScorecard(matrix) {
+    const lines = [
+        "Compatibility Scorecard",
+        "=======================",
+        `Target: ${matrix.targetPath}`,
+        ""
+    ];
+    for (const result of matrix.results) {
+        lines.push(`${result.client}: ${scoreForStatus(result.status)} (${result.status.toUpperCase()})`);
+    }
+    return lines.join("\n");
+}

package/dist/run-cli.js

@@ -2,10 +2,12 @@ import { writeFile } from "node:fs/promises";
 import { discoverInstalledPlugins, filterInstalledPlugins } from "./core/discover-installed-plugins.js";
 import { buildCompatibilityMatrix, matrixExitCode } from "./compatibility/compatibility-matrix.js";
 import { buildClaudeDesktopInstallPreview, renderClaudeDesktopInstallPreview } from "./compatibility/claude-desktop-install-preview.js";
+import { buildCursorInstallPreview, renderCursorInstallPreview } from "./compatibility/cursor-install-preview.js";
 import { applyDoctorConfig, loadDoctorConfig } from "./core/doctor-config.js";
 import { initPluginPackage } from "./core/init-plugin.js";
 import { runCheck } from "./index.js";
 import { renderInstalledSummary } from "./reporting/render-installed-summary.js";
+import { renderCompatibilityScorecard } from "./reporting/render-compatibility-scorecard.js";
 import { renderCompatibilityReport } from "./reporting/render-compatibility-report.js";
 import { renderJsonReport } from "./reporting/render-json-report.js";
 import { buildMarkdownReport } from "./reporting/render-markdown-report.js";
@@ -26,7 +28,7 @@ const defaultIo = {
     }
 };
 function printUsage(io) {
-    io.writeStderr("Usage: codex-plugin-doctor check <path|--installed> [filter] [--json|--markdown] [--output <path>] [--runtime] [--verbose-runtime] [--no-animations] [--ascii]\n       codex-plugin-doctor compat <path> [--client <client>] [--json] [--output <path>] [--install-preview]\n       codex-plugin-doctor list --installed\n       codex-plugin-doctor explain <finding-id>\n       codex-plugin-doctor --version");
+    io.writeStderr("Usage: codex-plugin-doctor check <path|--installed> [filter] [--json|--markdown] [--output <path>] [--runtime] [--verbose-runtime] [--no-animations] [--ascii]\n       codex-plugin-doctor compat <path> [--client <client>] [--json] [--scorecard] [--output <path>] [--install-preview]\n       codex-plugin-doctor list --installed\n       codex-plugin-doctor explain <finding-id>\n       codex-plugin-doctor --version");
 }
 function renderInstalledPlugins(plugins) {
     const lines = [
@@ -114,6 +116,7 @@ export async function runCli(args, io = defaultIo, options = {}) {
             ? [maybePath, ...remainingArgs]
             : remainingArgs;
         const jsonOutput = compatFlags.includes("--json");
+        const scorecardOutput = compatFlags.includes("--scorecard");
         const installPreview = compatFlags.includes("--install-preview");
         const clientIndex = compatFlags.indexOf("--client");
         const clientFilter = clientIndex === -1 ? null : compatFlags[clientIndex + 1];
@@ -127,16 +130,21 @@ export async function runCli(args, io = defaultIo, options = {}) {
             io.writeStderr("Missing path after --output.");
             return 2;
         }
-        if (installPreview && clientFilter?.toLowerCase() !== "claude-desktop") {
-            io.writeStderr("--install-preview requires --client claude-desktop.");
+        if (installPreview &&
+            clientFilter?.toLowerCase() !== "claude-desktop" &&
+            clientFilter?.toLowerCase() !== "cursor") {
+            io.writeStderr("--install-preview requires --client claude-desktop or --client cursor.");
             return 2;
         }
         if (installPreview) {
             try {
-                const preview = await buildClaudeDesktopInstallPreview(targetPath, {
-                    env: terminalContext.env
-                });
-                const report = renderClaudeDesktopInstallPreview(preview);
+                const report = clientFilter?.toLowerCase() === "cursor"
+                    ? renderCursorInstallPreview(await buildCursorInstallPreview(targetPath, {
+                        env: terminalContext.env
+                    }))
+                    : renderClaudeDesktopInstallPreview(await buildClaudeDesktopInstallPreview(targetPath, {
+                        env: terminalContext.env
+                    }));
                 if (outputPath) {
                     await writeFile(outputPath, report, "utf8");
                 }
@@ -162,7 +170,9 @@ export async function runCli(args, io = defaultIo, options = {}) {
         }
         const report = jsonOutput
             ? JSON.stringify({ schemaVersion: "1.0.0", ...matrix }, null, 2)
-            : renderCompatibilityReport(matrix);
+            : scorecardOutput
+                ? renderCompatibilityScorecard(matrix)
+                : renderCompatibilityReport(matrix);
         if (outputPath) {
             await writeFile(outputPath, report, "utf8");
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codex-plugin-doctor",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "CLI-first validator for Codex plugins, skills, and MCP package surfaces with runtime MCP protocol validation.",
   "type": "module",
   "main": "./dist/index.js",