codex-plugin-doctor 0.1.5 → 0.2.1

package/README.md

@@ -157,6 +157,13 @@ Run these from a Codex plugin package root:
 ```bash
 codex-plugin-doctor --version
 codex-plugin-doctor init my-plugin
+codex-plugin-doctor compat .
+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 . --json
+codex-plugin-doctor compat . --json --output compatibility.json
 codex-plugin-doctor check .
 codex-plugin-doctor check . --json
 codex-plugin-doctor check . --json --output report.json
@@ -169,6 +176,8 @@ codex-plugin-doctor check . --config .codex-doctor.json
 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.
+
 Optional local policy file:
 
 ```json
@@ -202,7 +211,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: Esquetta/CodexPluginDoctor@v0.1.4
+      - uses: Esquetta/CodexPluginDoctor@v0.2.0
         with:
           path: .
           runtime: "false"

package/dist/compatibility/claude-desktop-install-preview.d.ts

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

package/dist/compatibility/claude-desktop-install-preview.js

@@ -0,0 +1,69 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { getClaudeDesktopConfigPath, 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 buildClaudeDesktopInstallPreview(targetPath, environment = {}) {
+    const rootPath = path.resolve(targetPath);
+    const configPath = getClaudeDesktopConfigPath(environment);
+    if (!configPath) {
+        throw new Error("Claude Desktop config path could not be resolved on this platform.");
+    }
+    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,
+        snippet: {
+            mcpServers: Object.fromEntries(Object.entries(servers).map(([serverName, serverConfig]) => [
+                serverName,
+                normalizeServerConfig(serverConfig, rootPath)
+            ]))
+        }
+    };
+}
+export function renderClaudeDesktopInstallPreview(preview) {
+    return [
+        "Claude Desktop Install Preview",
+        "==============================",
+        `Target: ${preview.targetPath}`,
+        `Config: ${preview.configPath}`,
+        "",
+        "Add or merge this snippet into `claude_desktop_config.json`:",
+        JSON.stringify(preview.snippet, null, 2),
+        "",
+        "No files were modified."
+    ].join("\n");
+}

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

@@ -0,0 +1,20 @@
+export type CompatibilityStatus = "pass" | "warn" | "fail" | "skipped";
+export interface CompatibilityResult {
+    client: string;
+    status: CompatibilityStatus;
+    summary: string;
+    details: string[];
+}
+export interface CompatibilityMatrix {
+    targetPath: string;
+    results: CompatibilityResult[];
+}
+export interface CompatibilityEnvironment {
+    env?: Record<string, string | undefined>;
+    platform?: NodeJS.Platform;
+    homedir?: string;
+}
+export declare function readMcpConfigPath(targetPath: string): Promise<string | null>;
+export declare function getClaudeDesktopConfigPath(environment?: CompatibilityEnvironment): string | null;
+export declare function buildCompatibilityMatrix(targetPath: string, environment?: CompatibilityEnvironment): Promise<CompatibilityMatrix>;
+export declare function matrixExitCode(matrix: CompatibilityMatrix): 0 | 1;

package/dist/compatibility/compatibility-matrix.js

@@ -0,0 +1,244 @@
+import { readFile, stat } from "node:fs/promises";
+import os from "node:os";
+import path from "node:path";
+import { validatePlugin } from "../core/validate-plugin.js";
+async function fileExists(targetPath) {
+    try {
+        const details = await stat(targetPath);
+        return details.isFile();
+    }
+    catch {
+        return false;
+    }
+}
+async function directoryExists(targetPath) {
+    try {
+        const details = await stat(targetPath);
+        return details.isDirectory();
+    }
+    catch {
+        return false;
+    }
+}
+function statusFromCheckResult(result) {
+    if (result.status === "fail") {
+        return "fail";
+    }
+    if (result.status === "warn") {
+        return "warn";
+    }
+    return "pass";
+}
+export async function readMcpConfigPath(targetPath) {
+    const rootPath = path.resolve(targetPath);
+    const directMcpPath = path.join(rootPath, ".mcp.json");
+    if (await fileExists(directMcpPath)) {
+        return directMcpPath;
+    }
+    const manifestPath = path.join(rootPath, ".codex-plugin", "plugin.json");
+    if (!(await fileExists(manifestPath))) {
+        return null;
+    }
+    try {
+        const manifest = JSON.parse(await readFile(manifestPath, "utf8"));
+        return typeof manifest.mcpServers === "string"
+            ? path.resolve(rootPath, manifest.mcpServers)
+            : null;
+    }
+    catch {
+        return null;
+    }
+}
+async function hasCodexManifest(targetPath) {
+    return fileExists(path.join(path.resolve(targetPath), ".codex-plugin", "plugin.json"));
+}
+async function checkGenericMcp(targetPath) {
+    const mcpConfigPath = await readMcpConfigPath(targetPath);
+    if (!mcpConfigPath || !(await fileExists(mcpConfigPath))) {
+        return {
+            client: "Generic MCP",
+            status: "skipped",
+            summary: "No MCP config found.",
+            details: ["Expected `.mcp.json` or manifest `mcpServers` reference."]
+        };
+    }
+    try {
+        const parsed = JSON.parse(await readFile(mcpConfigPath, "utf8"));
+        const servers = parsed.mcpServers;
+        if (typeof servers !== "object" ||
+            servers === null ||
+            Array.isArray(servers) ||
+            Object.keys(servers).length === 0) {
+            return {
+                client: "Generic MCP",
+                status: "fail",
+                summary: "MCP config does not contain a non-empty `mcpServers` object.",
+                details: [mcpConfigPath]
+            };
+        }
+        return {
+            client: "Generic MCP",
+            status: "pass",
+            summary: "MCP server config is valid.",
+            details: [mcpConfigPath]
+        };
+    }
+    catch {
+        return {
+            client: "Generic MCP",
+            status: "fail",
+            summary: "MCP config is not valid JSON.",
+            details: [mcpConfigPath]
+        };
+    }
+}
+async function readMcpServerNames(targetPath) {
+    const mcpConfigPath = await readMcpConfigPath(targetPath);
+    if (!mcpConfigPath || !(await fileExists(mcpConfigPath))) {
+        return [];
+    }
+    try {
+        const parsed = JSON.parse(await readFile(mcpConfigPath, "utf8"));
+        const servers = parsed.mcpServers;
+        return typeof servers === "object" && servers !== null && !Array.isArray(servers)
+            ? Object.keys(servers)
+            : [];
+    }
+    catch {
+        return [];
+    }
+}
+export function getClaudeDesktopConfigPath(environment = {}) {
+    const platform = environment.platform ?? process.platform;
+    const env = environment.env ?? process.env;
+    const homeDirectory = environment.homedir ?? os.homedir();
+    if (platform === "win32") {
+        const appData = env.APPDATA;
+        return appData ? path.join(appData, "Claude", "claude_desktop_config.json") : null;
+    }
+    if (platform === "darwin") {
+        return path.join(homeDirectory, "Library", "Application Support", "Claude", "claude_desktop_config.json");
+    }
+    return null;
+}
+async function checkClaudeDesktop(targetPath, genericMcpResult, environment = {}) {
+    if (genericMcpResult.status !== "pass") {
+        return {
+            client: "Claude Desktop",
+            status: "skipped",
+            summary: "No valid MCP package config is available for Claude Desktop.",
+            details: ["Add a valid `.mcp.json` with a non-empty `mcpServers` object first."]
+        };
+    }
+    const configPath = getClaudeDesktopConfigPath(environment);
+    if (!configPath) {
+        return {
+            client: "Claude Desktop",
+            status: "warn",
+            summary: "Claude Desktop config path could not be resolved on this platform.",
+            details: ["Claude Desktop local config detection currently supports Windows and macOS."]
+        };
+    }
+    if (!(await fileExists(configPath))) {
+        const configDirectory = path.dirname(configPath);
+        return {
+            client: "Claude Desktop",
+            status: await directoryExists(configDirectory) ? "pass" : "warn",
+            summary: await directoryExists(configDirectory)
+                ? "Claude Desktop directory exists and a config file can be created."
+                : "Claude Desktop was not detected on this machine.",
+            details: [
+                configPath,
+                "Claude Desktop can add stdio MCP servers through `claude_desktop_config.json` when the app is installed."
+            ]
+        };
+    }
+    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: "Claude Desktop",
+                status: "fail",
+                summary: "Claude Desktop 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: "Claude Desktop",
+                status: "warn",
+                summary: "Claude Desktop already has MCP server names from this package.",
+                details: [
+                    configPath,
+                    ...duplicateServerNames.map((serverName) => `Duplicate server: ${serverName}`)
+                ]
+            };
+        }
+        return {
+            client: "Claude Desktop",
+            status: "pass",
+            summary: "Claude Desktop config is valid and this MCP package can be added.",
+            details: [
+                configPath,
+                `Source package: ${path.resolve(targetPath)}`
+            ]
+        };
+    }
+    catch {
+        return {
+            client: "Claude Desktop",
+            status: "fail",
+            summary: "Claude Desktop config is not valid JSON.",
+            details: [configPath, "Repair the local Claude Desktop 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 codexResult = await validatePlugin(rootPath);
+    const codexStatus = statusFromCheckResult(codexResult);
+    const codexCompatibility = !await hasCodexManifest(rootPath)
+        && genericMcpResult.status === "pass"
+        ? {
+            client: "Codex",
+            status: "skipped",
+            summary: "No Codex plugin manifest found; treating target as a standalone MCP package.",
+            details: ["Add `.codex-plugin/plugin.json` if this package should be installable as a Codex plugin."]
+        }
+        : {
+            client: "Codex",
+            status: codexStatus,
+            summary: codexStatus === "pass"
+                ? "Codex plugin package validation passed."
+                : "Codex plugin package validation produced findings.",
+            details: codexResult.findings.map((finding) => finding.id)
+        };
+    const results = [
+        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."]
+        }
+    ];
+    return {
+        targetPath: rootPath,
+        results
+    };
+}
+export function matrixExitCode(matrix) {
+    return matrix.results.some((result) => result.status === "fail") ? 1 : 0;
+}

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

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

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

@@ -0,0 +1,18 @@
+function statusLabel(status) {
+    return status.toUpperCase();
+}
+export function renderCompatibilityReport(matrix) {
+    const lines = [
+        "Compatibility Matrix",
+        "====================",
+        `Target: ${matrix.targetPath}`,
+        ""
+    ];
+    for (const result of matrix.results) {
+        lines.push(`${result.client}: ${statusLabel(result.status)} - ${result.summary}`);
+        for (const detail of result.details) {
+            lines.push(`  - ${detail}`);
+        }
+    }
+    return lines.join("\n");
+}

package/dist/run-cli.js

@@ -1,9 +1,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 { 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 { renderCompatibilityReport } from "./reporting/render-compatibility-report.js";
 import { renderJsonReport } from "./reporting/render-json-report.js";
 import { buildMarkdownReport } from "./reporting/render-markdown-report.js";
 import { renderRuleExplanation } from "./reporting/render-rule-explanation.js";
@@ -23,7 +26,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 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] [--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 = [
@@ -42,6 +45,25 @@ function renderInstalledPlugins(plugins) {
     }
     return lines.join("\n");
 }
+const compatibilityClientAliases = {
+    codex: "Codex",
+    "generic-mcp": "Generic MCP",
+    generic: "Generic MCP",
+    mcp: "Generic MCP",
+    "claude-desktop": "Claude Desktop",
+    claude: "Claude Desktop",
+    cursor: "Cursor"
+};
+function filterCompatibilityMatrix(matrix, clientFilter) {
+    const client = compatibilityClientAliases[clientFilter.toLowerCase()];
+    if (!client) {
+        return null;
+    }
+    return {
+        ...matrix,
+        results: matrix.results.filter((result) => result.client === client)
+    };
+}
 export async function runCli(args, io = defaultIo, options = {}) {
     const [command, maybePath, ...remainingArgs] = args;
     if (command === "--version" || command === "-v" || command === "version") {
@@ -86,6 +108,67 @@ export async function runCli(args, io = defaultIo, options = {}) {
         ].join("\n"));
         return 0;
     }
+    if (command === "compat") {
+        const targetPath = maybePath && !maybePath.startsWith("--") ? maybePath : ".";
+        const compatFlags = maybePath && maybePath.startsWith("--")
+            ? [maybePath, ...remainingArgs]
+            : remainingArgs;
+        const jsonOutput = compatFlags.includes("--json");
+        const installPreview = compatFlags.includes("--install-preview");
+        const clientIndex = compatFlags.indexOf("--client");
+        const clientFilter = clientIndex === -1 ? null : compatFlags[clientIndex + 1];
+        const outputIndex = compatFlags.indexOf("--output");
+        const outputPath = outputIndex === -1 ? null : compatFlags[outputIndex + 1];
+        if (clientIndex !== -1 && (!clientFilter || clientFilter.startsWith("--"))) {
+            io.writeStderr("Missing client after --client.");
+            return 2;
+        }
+        if (outputIndex !== -1 && (!outputPath || outputPath.startsWith("--"))) {
+            io.writeStderr("Missing path after --output.");
+            return 2;
+        }
+        if (installPreview && clientFilter?.toLowerCase() !== "claude-desktop") {
+            io.writeStderr("--install-preview requires --client claude-desktop.");
+            return 2;
+        }
+        if (installPreview) {
+            try {
+                const preview = await buildClaudeDesktopInstallPreview(targetPath, {
+                    env: terminalContext.env
+                });
+                const report = renderClaudeDesktopInstallPreview(preview);
+                if (outputPath) {
+                    await writeFile(outputPath, report, "utf8");
+                }
+                io.writeStdout(report);
+                return 0;
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : "Unknown install preview error.";
+                io.writeStderr(message);
+                return 1;
+            }
+        }
+        let matrix = await buildCompatibilityMatrix(targetPath, {
+            env: terminalContext.env
+        });
+        if (clientFilter) {
+            const filteredMatrix = filterCompatibilityMatrix(matrix, clientFilter);
+            if (!filteredMatrix) {
+                io.writeStderr(`Unknown compatibility client: ${clientFilter}`);
+                return 2;
+            }
+            matrix = filteredMatrix;
+        }
+        const report = jsonOutput
+            ? JSON.stringify({ schemaVersion: "1.0.0", ...matrix }, null, 2)
+            : renderCompatibilityReport(matrix);
+        if (outputPath) {
+            await writeFile(outputPath, report, "utf8");
+        }
+        io.writeStdout(report);
+        return matrixExitCode(matrix);
+    }
     if (command !== "check") {
         printUsage(io);
         return 2;

package/package.json

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