Skip to content

README.md

Latest commit

 

History

History
94 lines (63 loc) · 2.11 KB

README.md

File metadata and controls

94 lines (63 loc) · 2.11 KB
Raw

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:

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:

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:

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:

codex-plugin-doctor mcp examples/codex-doctor-generic-mcp

Suggested Local Flow

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