codex-plugin-doctor 1.57.0 → 1.58.0

package/dist/mcp/generic-mcp-doctor.js

@@ -1,6 +1,7 @@
 import { realpath, stat } from "node:fs/promises";
 import path from "node:path";
 import { buildCompatibilityMatrix, readMcpConfigPath } from "../compatibility/compatibility-matrix.js";
+import { normalizeMcpConfig } from "../core/mcp-config-normalizer.js";
 import { readJsonFile } from "../core/read-json-file.js";
 import { probeRuntimeConfig, remoteReliabilityGatePassed } from "../core/runtime-probe.js";
 import { formatFindingFingerprintLine, withFindingFingerprints } from "../reporting/finding-fingerprint.js";
@@ -15,9 +16,6 @@ function buildFinding(severity, id, message, impact, suggestedFix, evidence) {
         ...(evidence ? { evidence } : {})
     };
 }
-function isPlainObject(value) {
-    return typeof value === "object" && value !== null && !Array.isArray(value);
-}
 async function fileExists(targetPath) {
     try {
         const details = await stat(targetPath);
@@ -32,6 +30,13 @@ function isPathWithinRoot(rootPath, candidatePath) {
     return (relativePath === "" ||
         (!relativePath.startsWith("..") && !path.isAbsolute(relativePath)));
 }
+function isMcpConfigPathOutsideRootError(error) {
+    return error instanceof Error && (error.message === "MCP config path resolves outside the package root." ||
+        error.message === "Manifest MCP config path resolves outside the package root.");
+}
+function buildMcpConfigPathOutsideRootFinding(configPath) {
+    return buildFinding("fail", "mcp.config.path_outside_root", "The MCP config path resolves outside the target root.", "A package that reads MCP configuration outside its root is harder to audit and can depend on unreviewed local files.", "Keep `.mcp.json` or the manifest `mcpServers` reference inside the package root.", { configPath, field: "configPath" });
+}
 function buildStaticMcpFindings(configPath, parsedConfig) {
     if (!configPath) {
         return {
@@ -41,29 +46,24 @@ function buildStaticMcpFindings(configPath, parsedConfig) {
             ]
         };
     }
-    if (!isPlainObject(parsedConfig)) {
-        return {
-            serverCount: 0,
-            findings: [
-                buildFinding("fail", "mcp.config.invalid_shape", "The MCP config must be a JSON object.", "MCP clients expect object-shaped configuration so server entries can be resolved deterministically.", `Wrap the MCP config in a top-level object inside \`${configPath}\`.`, { configPath, field: "root" })
-            ]
-        };
-    }
-    const servers = parsedConfig.mcpServers;
-    if (!isPlainObject(servers) || Object.keys(servers).length === 0) {
+    const normalizedConfig = normalizeMcpConfig(parsedConfig);
+    if (!normalizedConfig.ok) {
+        if (normalizedConfig.field === "server" && normalizedConfig.invalidServerNames) {
+            return {
+                serverCount: 0,
+                findings: normalizedConfig.invalidServerNames.map((serverName) => buildFinding("fail", "mcp.server.invalid", `The MCP server \`${serverName}\` must be configured as an object.`, "MCP clients cannot interpret a server entry unless it is represented as an object with server options.", `Change the \`${serverName}\` entry in \`${configPath}\` to an object.`, { configPath, serverName, field: "server" }))
+            };
+        }
         return {
             serverCount: 0,
             findings: [
-                buildFinding("fail", "mcp.config.invalid_shape", "The MCP config must contain a non-empty `mcpServers` object.", "Without server entries, MCP clients cannot discover any package capabilities.", `Define MCP servers under \`mcpServers\` in \`${configPath}\`.`, { configPath, field: "mcpServers" })
+                buildFinding("fail", "mcp.config.invalid_shape", "The MCP config must contain a valid MCP server map.", "Without server entries, MCP clients cannot discover any package capabilities.", `Use a direct server map, \`mcp_servers\`, or \`mcpServers\` in \`${configPath}\`.`, { configPath, field: normalizedConfig.field })
             ]
         };
     }
+    const servers = normalizedConfig.servers;
     const findings = [];
     for (const [serverName, serverConfig] of Object.entries(servers)) {
-        if (!isPlainObject(serverConfig)) {
-            findings.push(buildFinding("fail", "mcp.server.invalid", `The MCP server \`${serverName}\` must be configured as an object.`, "MCP clients cannot interpret a server entry unless it is represented as an object with server options.", `Change the \`${serverName}\` entry in \`${configPath}\` to an object.`, { configPath, serverName, field: "server" }));
-            continue;
-        }
         const command = serverConfig.command;
         const url = serverConfig.url;
         if (typeof command !== "string" && typeof url !== "string") {
@@ -90,7 +90,18 @@ function mergeReportStatus(findings, security) {
 export async function buildGenericMcpDoctor(targetPath, environment = {}, options = {}) {
     const rootPath = path.resolve(targetPath);
     const compatibility = await buildCompatibilityMatrix(rootPath, environment);
-    const mcpConfigPath = await readMcpConfigPath(rootPath);
+    let mcpConfigPath;
+    let mcpConfigPathOutsideRoot = false;
+    try {
+        mcpConfigPath = await readMcpConfigPath(rootPath);
+    }
+    catch (error) {
+        if (!isMcpConfigPathOutsideRootError(error)) {
+            throw error;
+        }
+        mcpConfigPath = null;
+        mcpConfigPathOutsideRoot = true;
+    }
     const canonicalRootPath = await realpath(rootPath).catch(() => null);
     const canonicalMcpConfigPath = mcpConfigPath
         ? await realpath(mcpConfigPath).catch(() => null)
@@ -98,18 +109,17 @@ export async function buildGenericMcpDoctor(targetPath, environment = {}, option
     let parsedConfig = null;
     let staticFindings = [];
     let serverCount = 0;
-    if (!mcpConfigPath || !(await fileExists(mcpConfigPath))) {
+    if (mcpConfigPathOutsideRoot) {
+        staticFindings = [buildMcpConfigPathOutsideRootFinding(".mcp.json")];
+    }
+    else if (!mcpConfigPath || !(await fileExists(mcpConfigPath))) {
         staticFindings = buildStaticMcpFindings(null, null).findings;
     }
     else if (!canonicalRootPath ||
         !canonicalMcpConfigPath ||
         !isPathWithinRoot(canonicalRootPath, canonicalMcpConfigPath)) {
         staticFindings = [
-            buildFinding("fail", "mcp.config.path_outside_root", "The MCP config path resolves outside the target root.", "A package that reads MCP configuration outside its root is harder to audit and can depend on unreviewed local files.", "Keep `.mcp.json` or the manifest `mcpServers` reference inside the package root.", {
-                configPath: path.relative(rootPath, mcpConfigPath).replaceAll("\\", "/"),
-                resolvedPath: canonicalMcpConfigPath ?? mcpConfigPath,
-                field: "configPath"
-            })
+            buildMcpConfigPathOutsideRootFinding(path.relative(rootPath, mcpConfigPath).replaceAll("\\", "/"))
         ];
     }
     else {
@@ -128,9 +138,12 @@ export async function buildGenericMcpDoctor(targetPath, environment = {}, option
             ];
         }
     }
-    const security = buildSecurityAuditFromFindings(rootPath, mcpConfigPath && parsedConfig !== null
-        ? auditMcpServerConfig(rootPath, parsedConfig, { configPath: mcpConfigPath })
-        : []);
+    const security = buildSecurityAuditFromFindings(rootPath, [
+        ...staticFindings.filter((finding) => finding.id === "mcp.config.path_outside_root"),
+        ...(mcpConfigPath && parsedConfig !== null
+            ? auditMcpServerConfig(rootPath, parsedConfig, { configPath: mcpConfigPath })
+            : [])
+    ]);
     const runtimeResult = options.runtime &&
         mcpConfigPath !== null &&
         parsedConfig !== null &&
@@ -156,7 +169,10 @@ export async function buildGenericMcpDoctor(targetPath, environment = {}, option
         exitCode: status === "fail" ? 1 : 0,
         mcpConfigPath,
         serverCount,
-        findings: [...fingerprintedFindings, ...security.findings],
+        findings: [
+            ...fingerprintedFindings,
+            ...security.findings.filter((finding) => !fingerprintedFindings.some((staticFinding) => staticFinding.fingerprint === finding.fingerprint))
+        ],
         security,
         compatibility,
         ...(runtimeResult ? { runtimeScorecard: runtimeResult.scorecard } : {}),

package/dist/rules/rule-catalog.js

@@ -53,6 +53,123 @@ export const ruleCatalog = [
         fix: "Add a short, specific `description` field to `.codex-plugin/plugin.json`.",
         example: '{ "description": "Validates GitHub PR automation workflows before release." }'
     },
+    {
+        id: "plugin.manifest.invalid_field",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "A plugin manifest optional field is invalid.",
+        why: "Malformed optional metadata cannot be interpreted reliably by Codex clients.",
+        fix: "Use the official type for the affected field in `.codex-plugin/plugin.json`.",
+        example: '{ "keywords": ["validation", "mcp"] }'
+    },
+    {
+        id: "plugin.manifest.invalid_path",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "A plugin manifest path is not a safe package-relative path.",
+        why: "Paths outside the plugin package can expose files that are not part of the plugin bundle.",
+        fix: "Use a `./` path that remains inside the plugin package.",
+        example: '{ "skills": "./skills" }'
+    },
+    {
+        id: "plugin.app.missing_file",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "The plugin manifest points to a missing .app.json file.",
+        why: "Codex cannot load an app manifest that is absent or not a regular file.",
+        fix: "Create the referenced app manifest as a regular JSON file inside the plugin package.",
+        example: '{ "apps": "./apps/example.app.json" }'
+    },
+    {
+        id: "plugin.app.invalid_json",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "The referenced .app.json file is not valid JSON.",
+        why: "Codex cannot parse the app manifest.",
+        fix: "Fix the JSON syntax in the referenced app manifest.",
+        example: "Use syntactically valid JSON in the referenced .app.json file."
+    },
+    {
+        id: "plugin.app.invalid_path",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "A plugin app path is not a safe package-relative path.",
+        why: "Paths outside the plugin package can expose files that are not part of the plugin bundle.",
+        fix: "Use an `./` app path that remains inside the plugin package.",
+        example: '{ "apps": "./apps/example.app.json" }'
+    },
+    {
+        id: "plugin.hook.missing_file",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "The plugin lifecycle hook source file is missing.",
+        why: "Codex cannot load a hook configuration file that is absent or not a regular file.",
+        fix: "Create the referenced hook configuration JSON file inside the plugin package.",
+        example: '{ "hooks": "./hooks/hooks.json" }'
+    },
+    {
+        id: "plugin.hook.invalid_json",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "The plugin lifecycle hook source is not valid JSON.",
+        why: "Codex cannot parse the hook configuration.",
+        fix: "Fix the JSON syntax in the hook configuration file.",
+        example: "Use syntactically valid JSON in the hook configuration file."
+    },
+    {
+        id: "plugin.hook.invalid_shape",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "The plugin lifecycle hook configuration has an invalid shape.",
+        why: "Codex cannot safely interpret malformed lifecycle hook metadata.",
+        fix: "Use the official hook configuration schema for the affected field.",
+        example: '{ "hooks": { "PreToolUse": [{ "hooks": [{ "type": "command", "command": "node hooks/check.js" }] }] } }'
+    },
+    {
+        id: "plugin.hook.invalid_path",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "The plugin lifecycle hook source is not a safe package-relative path.",
+        why: "Paths outside the plugin package can expose unreviewed files to hook configuration loading.",
+        fix: "Use a `./` hook configuration path that stays within the plugin package.",
+        example: '{ "hooks": "./hooks/hooks.json" }'
+    },
+    {
+        id: "plugin.hook.unsupported_event",
+        category: "package",
+        defaultSeverity: "fail",
+        summary: "A plugin lifecycle hook event is not supported.",
+        why: "Codex will not invoke hook events outside the official lifecycle event set.",
+        fix: "Use one of the official plugin lifecycle hook events.",
+        example: '{ "hooks": { "SessionStart": [] } }'
+    },
+    {
+        id: "plugin.hook.unsupported_handler",
+        category: "package",
+        defaultSeverity: "warn",
+        summary: "A plugin lifecycle hook uses a handler type the host skips.",
+        why: "Prompt and agent lifecycle handlers are not executed by this host.",
+        fix: "Use a command handler for behavior that must run in this host.",
+        example: '{ "type": "command", "command": "node hooks/check.js" }'
+    },
+    {
+        id: "plugin.hook.async_unsupported",
+        category: "package",
+        defaultSeverity: "warn",
+        summary: "A plugin lifecycle hook requests unsupported asynchronous execution.",
+        why: "The host does not support asynchronous lifecycle hook execution.",
+        fix: "Remove `async: true` or run the command synchronously.",
+        example: '{ "type": "command", "command": "node hooks/check.js" }'
+    },
+    {
+        id: "plugin.hook.matcher_ignored",
+        category: "package",
+        defaultSeverity: "warn",
+        summary: "A plugin lifecycle hook matcher is ignored for this event.",
+        why: "This lifecycle event does not use matcher filtering.",
+        fix: "Remove the matcher from this event group.",
+        example: '{ "hooks": { "Stop": [{ "hooks": [] }] } }'
+    },
     {
         id: "plugin.heuristic.description.too_long",
         category: "package",
@@ -138,10 +255,19 @@ export const ruleCatalog = [
         id: "plugin.mcp.invalid_shape",
         category: "mcp",
         defaultSeverity: "fail",
-        summary: "The `.mcp.json` file does not expose a valid `mcpServers` object.",
-        why: "Codex expects MCP configuration to be object-shaped with named server entries.",
-        fix: "Define a non-empty top-level `mcpServers` object.",
-        example: '{ "mcpServers": { "doctor": { "command": "node", "args": ["server.js"] } } }'
+        summary: "The `.mcp.json` file does not contain one non-empty supported server map.",
+        why: "Codex accepts exactly a direct server map, an `mcp_servers` wrapper, or the legacy `mcpServers` wrapper.",
+        fix: "Use exactly one non-empty direct server map, `mcp_servers`, or legacy `mcpServers` wrapper.",
+        example: '{ "doctor": { "command": "node", "args": ["server.js"] } }'
+    },
+    {
+        id: "plugin.mcp.ambiguous_shape",
+        category: "mcp",
+        defaultSeverity: "fail",
+        summary: "The `.mcp.json` file uses an ambiguous MCP config layout.",
+        why: "Codex cannot safely choose between multiple wrapper layouts when they appear in one configuration file.",
+        fix: "Use exactly one supported layout: a direct server map, `mcp_servers`, or `mcpServers`.",
+        example: '{ "weather": { "command": "node", "args": ["server.js"] } }'
     },
     {
         id: "plugin.mcp.server.invalid",

package/dist/security/security-audit.d.ts

@@ -10,6 +10,7 @@ export interface SecurityAudit {
     };
     findings: Finding[];
 }
+export declare function auditHookCommand(rootPath: string, sourcePath: string, event: string, field: string, command: string): Finding[];
 export declare function auditMcpServerConfig(rootPath: string, parsedConfig: unknown, options?: {
     configPath?: string;
 }): Finding[];

package/dist/security/security-audit.js

@@ -1,6 +1,7 @@
 import { readFile, readdir, stat } from "node:fs/promises";
 import path from "node:path";
 import { discoverPackage } from "../core/discover-package.js";
+import { normalizeMcpConfig } from "../core/mcp-config-normalizer.js";
 import { readJsonFile } from "../core/read-json-file.js";
 import { inspectRemoteMcpUrl } from "../core/remote-url-policy.js";
 import { validatePlugin } from "../core/validate-plugin.js";
@@ -58,6 +59,101 @@ function containsPipeInstaller(args) {
         /\b(iwr|irm|invoke-webrequest|invoke-restmethod)\b[^|]*\|\s*(iex|invoke-expression)\b/.test(joinedArgs) ||
         /\binvoke-expression\b/.test(joinedArgs));
 }
+function relativeSourcePath(rootPath, sourcePath) {
+    return relativePackagePath(rootPath, path.resolve(rootPath, sourcePath));
+}
+export function auditHookCommand(rootPath, sourcePath, event, field, command) {
+    const evidence = { sourcePath: relativeSourcePath(rootPath, sourcePath), event, field };
+    const findings = [];
+    if (/(?:^|\s)[/-]enc(?:odedcommand)?(?=\s|$)/i.test(command)) {
+        findings.push(buildFinding("fail", "plugin.security.encoded_command", "A plugin lifecycle hook uses an encoded shell command flag.", "Encoded command payloads hide the executed script from reviewers and increase supply-chain risk.", "Replace encoded shell payloads with a checked-in script or readable direct command.", evidence));
+    }
+    if (containsHookRemotePipeInstaller(command)) {
+        findings.push(buildFinding("fail", "plugin.security.remote_pipe_install", "A plugin lifecycle hook appears to pipe remote content into a shell.", "Download-and-execute patterns can run unreviewed remote code when a host invokes the hook.", "Pin dependencies through the package manager or use a reviewed local script instead of piping remote content to a shell.", evidence));
+    }
+    if (/^\s*(?:cmd(?:\.exe)?\s+\/c|(?:powershell|pwsh)(?:\.exe)?\s+-(?:command|c)\b)/i.test(command)) {
+        findings.push(buildFinding("warn", "plugin.security.command_shell_wrapper", "A plugin lifecycle hook starts through a shell wrapper.", "Shell wrappers expand quoting, pipes, aliases, and platform-specific behavior, which makes the execution path harder to audit.", "Prefer a concrete executable or checked-in script with explicit arguments.", evidence));
+    }
+    return findings;
+}
+function containsHookRemotePipeInstaller(command) {
+    const firstPipeIndex = command.indexOf("|");
+    if (firstPipeIndex === -1)
+        return false;
+    const leftHandSide = command.slice(0, firstPipeIndex);
+    const rightHandSide = command.slice(firstPipeIndex + 1).trim();
+    const interpreter = /^(?:\/(?:[^/\s|]+\/)*(?:sh|bash)\b|(?:sh|bash)\b|(?:powershell|pwsh)(?:\.exe)?\s+-(?:command|c)\s+-\s*(?:$|[;&|])|(?:iex|invoke-expression)\b)/i;
+    return isInvokedHookDownloader(leftHandSide) && interpreter.test(rightHandSide);
+}
+function isInvokedHookDownloader(command) {
+    const tokens = command.trim().split(/\s+/).filter(Boolean);
+    let index = 0;
+    while (index < tokens.length) {
+        const token = tokens[index].toLowerCase();
+        if (token === "env") {
+            index += 1;
+            while (index < tokens.length) {
+                const envToken = tokens[index];
+                if (envToken === "--") {
+                    index += 1;
+                    break;
+                }
+                if (envToken === "-i" || envToken === "--ignore-environment") {
+                    index += 1;
+                    continue;
+                }
+                if (envToken === "-u" || envToken === "--unset") {
+                    if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(tokens[index + 1] ?? "")) {
+                        return false;
+                    }
+                    index += 2;
+                    continue;
+                }
+                if (/^--unset=[A-Za-z_][A-Za-z0-9_]*$/.test(envToken)) {
+                    index += 1;
+                    continue;
+                }
+                if (envToken === "-C" || envToken === "--chdir") {
+                    if (!tokens[index + 1] || tokens[index + 1].startsWith("-")) {
+                        return false;
+                    }
+                    index += 2;
+                    continue;
+                }
+                if (/^--chdir=\S+$/.test(envToken)) {
+                    index += 1;
+                    continue;
+                }
+                if (/^[A-Za-z_][A-Za-z0-9_]*=\S*$/.test(envToken)) {
+                    index += 1;
+                    continue;
+                }
+                break;
+            }
+            continue;
+        }
+        if (token === "command") {
+            index += 1;
+            if (tokens[index] === "-p" || tokens[index]?.toLowerCase() === "--default-search-path") {
+                index += 1;
+            }
+            if (tokens[index] === "--") {
+                index += 1;
+            }
+            continue;
+        }
+        break;
+    }
+    const downloader = normalizeCommandName(tokens[index] ?? "");
+    if (new Set(["curl", "wget", "iwr", "irm", "invoke-webrequest", "invoke-restmethod"]).has(downloader)) {
+        return true;
+    }
+    const shell = normalizeCommandName(tokens[index] ?? "");
+    return ((shell === "powershell" || shell === "pwsh") &&
+        /^-(?:command|c)$/i.test(tokens[index + 1] ?? "") &&
+        new Set(["curl", "wget", "iwr", "irm", "invoke-webrequest", "invoke-restmethod"])
+            .has(normalizeCommandName(tokens[index + 2] ?? "")));
+}
 const pathLikeArgFlags = new Set([
     "--config",
     "--config-path",
@@ -200,16 +296,14 @@ export function auditMcpServerConfig(rootPath, parsedConfig, options = {}) {
     const configPath = options.configPath
         ? relativePackagePath(rootPath, options.configPath)
         : ".mcp.json";
-    if (!isPlainObject(parsedConfig) || !isPlainObject(parsedConfig.mcpServers)) {
+    const normalizedConfig = normalizeMcpConfig(parsedConfig);
+    if (!normalizedConfig.ok) {
         return [
-            buildFinding("fail", "plugin.security.audit_unavailable", "The MCP security audit could not find a valid `mcpServers` object.", "Without server entries, the audit cannot evaluate command execution or remote transport risk.", "Define MCP servers under a top-level `mcpServers` object.", { configPath })
+            buildFinding("fail", "plugin.security.audit_unavailable", "The MCP security audit could not find a valid MCP server map.", "Without server entries, the audit cannot evaluate command execution or remote transport risk.", "Use a direct server map, `mcp_servers`, or `mcpServers`.", { configPath })
         ];
     }
     const findings = [];
-    for (const [serverName, serverConfig] of Object.entries(parsedConfig.mcpServers)) {
-        if (!isPlainObject(serverConfig)) {
-            continue;
-        }
+    for (const [serverName, serverConfig] of Object.entries(normalizedConfig.servers)) {
         const command = serverConfig.command;
         const args = serverConfig.args;
         const cwd = serverConfig.cwd;
@@ -395,7 +489,10 @@ async function auditMcpCommandSurface(discoveredPackage) {
 function dedupeFindings(findings) {
     const seen = new Set();
     return findings.filter((finding) => {
-        const key = `${finding.id}\n${finding.message}`;
+        const hookLocation = finding.evidence?.sourcePath && finding.evidence.event && finding.evidence.field
+            ? `${finding.evidence.sourcePath}\n${finding.evidence.event}\n${finding.evidence.field}`
+            : "";
+        const key = `${finding.id}\n${finding.message}\n${hookLocation}`;
         if (seen.has(key)) {
             return false;
         }

package/examples/README.md

@@ -1,94 +1,94 @@
-# Examples
-
-This folder contains manual example packs for local testing. Unlike `tests/fixtures`, these examples are meant for humans to run directly against the CLI.
-
-## Example Packs
-
-Use the smallest example that matches what you need to prove:
-
-- `codex-doctor-starter` for static manifest and skill validation.
-- `codex-doctor-runtime` for full MCP runtime probing and compatibility scoring.
-- `codex-doctor-risky` for security finding output.
-- `codex-doctor-generic-mcp` for MCP-only packages without a Codex plugin manifest.
-
-### `codex-doctor-starter`
-
-Minimal valid Codex plugin package with one skill and no runtime MCP server.
-
-Expected result:
-
-- static validation passes
-- no runtime probing needed
-
-Command:
-
-```bash
-codex-plugin-doctor check examples/codex-doctor-starter
-```
-
-### `codex-doctor-runtime`
-
-Valid Codex plugin package with:
-
-- skill metadata
-- `.mcp.json`
-- mock MCP stdio server
-- `tools/list`
-- `tools/call`
-- `resources/list`
-- `resources/read`
-- `resources/templates/list`
-- `prompts/list`
-- `prompts/get`
-
-Expected result:
-
-- static validation passes
-- runtime validation passes
-- runtime scorecard shows all supported runtime capabilities as `pass`
-
-Command:
-
-```bash
-codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
-```
-
-### `codex-doctor-risky`
-
-Intentionally flawed package for showing failure output.
-
-Expected result:
-
-- security finding for hard-coded secret
-
-Command:
-
-```bash
-codex-plugin-doctor check examples/codex-doctor-risky --ascii
-```
-
-### `codex-doctor-generic-mcp`
-
-Generic MCP package with a `.mcp.json` file and no Codex plugin manifest.
-
-Expected result:
-
-- `codex-plugin-doctor mcp` passes generic MCP static health checks
-- `codex-plugin-doctor check` still reports the missing Codex plugin manifest
-
-Command:
-
-```bash
-codex-plugin-doctor mcp examples/codex-doctor-generic-mcp
-```
-
-## Suggested Local Flow
-
-```bash
-npm install
-npm run build
-npm link
-codex-plugin-doctor check examples/codex-doctor-starter
-codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
-codex-plugin-doctor check examples/codex-doctor-risky --ascii
-```
+# Examples
+
+This folder contains manual example packs for local testing. Unlike `tests/fixtures`, these examples are meant for humans to run directly against the CLI.
+
+## Example Packs
+
+Use the smallest example that matches what you need to prove:
+
+- `codex-doctor-starter` for static manifest and skill validation.
+- `codex-doctor-runtime` for full MCP runtime probing and compatibility scoring.
+- `codex-doctor-risky` for security finding output.
+- `codex-doctor-generic-mcp` for MCP-only packages without a Codex plugin manifest.
+
+### `codex-doctor-starter`
+
+Minimal valid Codex plugin package with one skill and no runtime MCP server.
+
+Expected result:
+
+- static validation passes
+- no runtime probing needed
+
+Command:
+
+```bash
+codex-plugin-doctor check examples/codex-doctor-starter
+```
+
+### `codex-doctor-runtime`
+
+Valid Codex plugin package with:
+
+- skill metadata
+- `.mcp.json`
+- mock MCP stdio server
+- `tools/list`
+- `tools/call`
+- `resources/list`
+- `resources/read`
+- `resources/templates/list`
+- `prompts/list`
+- `prompts/get`
+
+Expected result:
+
+- static validation passes
+- runtime validation passes
+- runtime scorecard shows all supported runtime capabilities as `pass`
+
+Command:
+
+```bash
+codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
+```
+
+### `codex-doctor-risky`
+
+Intentionally flawed package for showing failure output.
+
+Expected result:
+
+- security finding for hard-coded secret
+
+Command:
+
+```bash
+codex-plugin-doctor check examples/codex-doctor-risky --ascii
+```
+
+### `codex-doctor-generic-mcp`
+
+Generic MCP package with a `.mcp.json` file and no Codex plugin manifest.
+
+Expected result:
+
+- `codex-plugin-doctor mcp` passes generic MCP static health checks
+- `codex-plugin-doctor check` still reports the missing Codex plugin manifest
+
+Command:
+
+```bash
+codex-plugin-doctor mcp examples/codex-doctor-generic-mcp
+```
+
+## Suggested Local Flow
+
+```bash
+npm install
+npm run build
+npm link
+codex-plugin-doctor check examples/codex-doctor-starter
+codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
+codex-plugin-doctor check examples/codex-doctor-risky --ascii
+```

package/examples/codex-doctor-generic-mcp/.mcp.json

@@ -1,10 +1,10 @@
-{
-  "mcpServers": {
-    "genericRuntime": {
-      "command": "node",
-      "args": [
-        "server.js"
-      ]
-    }
-  }
-}
+{
+  "mcpServers": {
+    "genericRuntime": {
+      "command": "node",
+      "args": [
+        "server.js"
+      ]
+    }
+  }
+}

package/examples/codex-doctor-generic-mcp/server.js

@@ -1 +1 @@
-process.stdin.resume();
+process.stdin.resume();