codex-plugin-doctor 1.57.0 → 1.59.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +20 -6
- package/dist/compatibility/claude-desktop-install-preview.js +4 -4
- package/dist/compatibility/cline-install-preview.js +4 -4
- package/dist/compatibility/compatibility-matrix.js +13 -17
- package/dist/compatibility/cursor-install-preview.js +4 -4
- package/dist/compatibility/windsurf-install-preview.js +4 -4
- package/dist/core/doctor-size.js +16 -1
- package/dist/core/init-plugin.js +2 -2
- package/dist/core/inspector-bridge.js +8 -13
- package/dist/core/mcp-config-normalizer.d.ts +18 -0
- package/dist/core/mcp-config-normalizer.js +50 -0
- package/dist/core/output-contract.js +76 -0
- package/dist/core/package-path.d.ts +1 -0
- package/dist/core/package-path.js +25 -0
- package/dist/core/plugin-components.d.ts +7 -0
- package/dist/core/plugin-components.js +169 -0
- package/dist/core/plugin-hooks.d.ts +2 -0
- package/dist/core/plugin-hooks.js +190 -0
- package/dist/core/runtime-plan.js +97 -16
- package/dist/core/runtime-probe.js +3 -8
- package/dist/core/shell-completion.js +29 -0
- package/dist/core/submission-assets.d.ts +6 -0
- package/dist/core/submission-assets.js +430 -0
- package/dist/core/submission-preflight.d.ts +34 -0
- package/dist/core/submission-preflight.js +289 -0
- package/dist/core/submission-ruleset.d.ts +56 -0
- package/dist/core/submission-ruleset.js +38 -0
- package/dist/core/submission-skill-metadata.d.ts +9 -0
- package/dist/core/submission-skill-metadata.js +301 -0
- package/dist/core/validate-plugin.js +39 -17
- package/dist/domain/types.d.ts +34 -0
- package/dist/domain/types.js +13 -1
- package/dist/index.d.ts +5 -0
- package/dist/index.js +5 -0
- package/dist/mcp/generic-mcp-doctor.js +45 -29
- package/dist/reporting/render-submission-report.d.ts +5 -0
- package/dist/reporting/render-submission-report.js +68 -0
- package/dist/rules/rule-catalog.js +130 -4
- package/dist/run-cli.js +96 -0
- package/dist/security/security-audit.d.ts +1 -0
- package/dist/security/security-audit.js +104 -7
- package/examples/README.md +94 -94
- package/examples/codex-doctor-generic-mcp/.mcp.json +10 -10
- package/examples/codex-doctor-generic-mcp/server.js +1 -1
- package/examples/codex-doctor-risky/.codex-plugin/plugin.json +7 -7
- package/examples/codex-doctor-risky/.mcp.json +12 -12
- package/examples/codex-doctor-risky/mock-server.js +1 -1
- package/examples/codex-doctor-runtime/.codex-plugin/plugin.json +8 -8
- package/examples/codex-doctor-runtime/.mcp.json +9 -9
- package/examples/codex-doctor-runtime/mock-server.js +237 -237
- package/examples/codex-doctor-runtime/skills/context-check/SKILL.md +7 -7
- package/examples/codex-doctor-starter/.codex-plugin/plugin.json +7 -7
- package/examples/codex-doctor-starter/skills/repo-scan/SKILL.md +7 -7
- package/package.json +5 -1
package/examples/README.md
CHANGED
|
@@ -1,94 +1,94 @@
|
|
|
1
|
-
# Examples
|
|
2
|
-
|
|
3
|
-
This folder contains manual example packs for local testing. Unlike `tests/fixtures`, these examples are meant for humans to run directly against the CLI.
|
|
4
|
-
|
|
5
|
-
## Example Packs
|
|
6
|
-
|
|
7
|
-
Use the smallest example that matches what you need to prove:
|
|
8
|
-
|
|
9
|
-
- `codex-doctor-starter` for static manifest and skill validation.
|
|
10
|
-
- `codex-doctor-runtime` for full MCP runtime probing and compatibility scoring.
|
|
11
|
-
- `codex-doctor-risky` for security finding output.
|
|
12
|
-
- `codex-doctor-generic-mcp` for MCP-only packages without a Codex plugin manifest.
|
|
13
|
-
|
|
14
|
-
### `codex-doctor-starter`
|
|
15
|
-
|
|
16
|
-
Minimal valid Codex plugin package with one skill and no runtime MCP server.
|
|
17
|
-
|
|
18
|
-
Expected result:
|
|
19
|
-
|
|
20
|
-
- static validation passes
|
|
21
|
-
- no runtime probing needed
|
|
22
|
-
|
|
23
|
-
Command:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
codex-plugin-doctor check examples/codex-doctor-starter
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
### `codex-doctor-runtime`
|
|
30
|
-
|
|
31
|
-
Valid Codex plugin package with:
|
|
32
|
-
|
|
33
|
-
- skill metadata
|
|
34
|
-
- `.mcp.json`
|
|
35
|
-
- mock MCP stdio server
|
|
36
|
-
- `tools/list`
|
|
37
|
-
- `tools/call`
|
|
38
|
-
- `resources/list`
|
|
39
|
-
- `resources/read`
|
|
40
|
-
- `resources/templates/list`
|
|
41
|
-
- `prompts/list`
|
|
42
|
-
- `prompts/get`
|
|
43
|
-
|
|
44
|
-
Expected result:
|
|
45
|
-
|
|
46
|
-
- static validation passes
|
|
47
|
-
- runtime validation passes
|
|
48
|
-
- runtime scorecard shows all supported runtime capabilities as `pass`
|
|
49
|
-
|
|
50
|
-
Command:
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### `codex-doctor-risky`
|
|
57
|
-
|
|
58
|
-
Intentionally flawed package for showing failure output.
|
|
59
|
-
|
|
60
|
-
Expected result:
|
|
61
|
-
|
|
62
|
-
- security finding for hard-coded secret
|
|
63
|
-
|
|
64
|
-
Command:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
codex-plugin-doctor check examples/codex-doctor-risky --ascii
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### `codex-doctor-generic-mcp`
|
|
71
|
-
|
|
72
|
-
Generic MCP package with a `.mcp.json` file and no Codex plugin manifest.
|
|
73
|
-
|
|
74
|
-
Expected result:
|
|
75
|
-
|
|
76
|
-
- `codex-plugin-doctor mcp` passes generic MCP static health checks
|
|
77
|
-
- `codex-plugin-doctor check` still reports the missing Codex plugin manifest
|
|
78
|
-
|
|
79
|
-
Command:
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
codex-plugin-doctor mcp examples/codex-doctor-generic-mcp
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
## Suggested Local Flow
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
npm install
|
|
89
|
-
npm run build
|
|
90
|
-
npm link
|
|
91
|
-
codex-plugin-doctor check examples/codex-doctor-starter
|
|
92
|
-
codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
|
|
93
|
-
codex-plugin-doctor check examples/codex-doctor-risky --ascii
|
|
94
|
-
```
|
|
1
|
+
# Examples
|
|
2
|
+
|
|
3
|
+
This folder contains manual example packs for local testing. Unlike `tests/fixtures`, these examples are meant for humans to run directly against the CLI.
|
|
4
|
+
|
|
5
|
+
## Example Packs
|
|
6
|
+
|
|
7
|
+
Use the smallest example that matches what you need to prove:
|
|
8
|
+
|
|
9
|
+
- `codex-doctor-starter` for static manifest and skill validation.
|
|
10
|
+
- `codex-doctor-runtime` for full MCP runtime probing and compatibility scoring.
|
|
11
|
+
- `codex-doctor-risky` for security finding output.
|
|
12
|
+
- `codex-doctor-generic-mcp` for MCP-only packages without a Codex plugin manifest.
|
|
13
|
+
|
|
14
|
+
### `codex-doctor-starter`
|
|
15
|
+
|
|
16
|
+
Minimal valid Codex plugin package with one skill and no runtime MCP server.
|
|
17
|
+
|
|
18
|
+
Expected result:
|
|
19
|
+
|
|
20
|
+
- static validation passes
|
|
21
|
+
- no runtime probing needed
|
|
22
|
+
|
|
23
|
+
Command:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
codex-plugin-doctor check examples/codex-doctor-starter
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### `codex-doctor-runtime`
|
|
30
|
+
|
|
31
|
+
Valid Codex plugin package with:
|
|
32
|
+
|
|
33
|
+
- skill metadata
|
|
34
|
+
- `.mcp.json`
|
|
35
|
+
- mock MCP stdio server
|
|
36
|
+
- `tools/list`
|
|
37
|
+
- `tools/call`
|
|
38
|
+
- `resources/list`
|
|
39
|
+
- `resources/read`
|
|
40
|
+
- `resources/templates/list`
|
|
41
|
+
- `prompts/list`
|
|
42
|
+
- `prompts/get`
|
|
43
|
+
|
|
44
|
+
Expected result:
|
|
45
|
+
|
|
46
|
+
- static validation passes
|
|
47
|
+
- runtime validation passes
|
|
48
|
+
- runtime scorecard shows all supported runtime capabilities as `pass`
|
|
49
|
+
|
|
50
|
+
Command:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### `codex-doctor-risky`
|
|
57
|
+
|
|
58
|
+
Intentionally flawed package for showing failure output.
|
|
59
|
+
|
|
60
|
+
Expected result:
|
|
61
|
+
|
|
62
|
+
- security finding for hard-coded secret
|
|
63
|
+
|
|
64
|
+
Command:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
codex-plugin-doctor check examples/codex-doctor-risky --ascii
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### `codex-doctor-generic-mcp`
|
|
71
|
+
|
|
72
|
+
Generic MCP package with a `.mcp.json` file and no Codex plugin manifest.
|
|
73
|
+
|
|
74
|
+
Expected result:
|
|
75
|
+
|
|
76
|
+
- `codex-plugin-doctor mcp` passes generic MCP static health checks
|
|
77
|
+
- `codex-plugin-doctor check` still reports the missing Codex plugin manifest
|
|
78
|
+
|
|
79
|
+
Command:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
codex-plugin-doctor mcp examples/codex-doctor-generic-mcp
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Suggested Local Flow
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npm install
|
|
89
|
+
npm run build
|
|
90
|
+
npm link
|
|
91
|
+
codex-plugin-doctor check examples/codex-doctor-starter
|
|
92
|
+
codex-plugin-doctor check examples/codex-doctor-runtime --json --runtime --verbose-runtime
|
|
93
|
+
codex-plugin-doctor check examples/codex-doctor-risky --ascii
|
|
94
|
+
```
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
{
|
|
2
|
-
"mcpServers": {
|
|
3
|
-
"genericRuntime": {
|
|
4
|
-
"command": "node",
|
|
5
|
-
"args": [
|
|
6
|
-
"server.js"
|
|
7
|
-
]
|
|
8
|
-
}
|
|
9
|
-
}
|
|
10
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"mcpServers": {
|
|
3
|
+
"genericRuntime": {
|
|
4
|
+
"command": "node",
|
|
5
|
+
"args": [
|
|
6
|
+
"server.js"
|
|
7
|
+
]
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
process.stdin.resume();
|
|
1
|
+
process.stdin.resume();
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "codex-doctor-risky",
|
|
3
|
-
"version": "1.0.0",
|
|
4
|
-
"description": "Intentionally risky sample package for showing Codex Doctor failure output.",
|
|
5
|
-
"mcpServers": "./.mcp.json"
|
|
6
|
-
}
|
|
7
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "codex-doctor-risky",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Intentionally risky sample package for showing Codex Doctor failure output.",
|
|
5
|
+
"mcpServers": "./.mcp.json"
|
|
6
|
+
}
|
|
7
|
+
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
{
|
|
2
|
-
"mcpServers": {
|
|
3
|
-
"dangerServer": {
|
|
4
|
-
"command": "node",
|
|
5
|
-
"args": ["./mock-server.js"],
|
|
6
|
-
"env": {
|
|
7
|
-
"OPENAI_API_KEY": "sk-live-example-secret-value"
|
|
8
|
-
}
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
|
|
1
|
+
{
|
|
2
|
+
"mcpServers": {
|
|
3
|
+
"dangerServer": {
|
|
4
|
+
"command": "node",
|
|
5
|
+
"args": ["./mock-server.js"],
|
|
6
|
+
"env": {
|
|
7
|
+
"OPENAI_API_KEY": "sk-live-example-secret-value"
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
|
|
@@ -1 +1 @@
|
|
|
1
|
-
process.stdin.resume();
|
|
1
|
+
process.stdin.resume();
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "codex-doctor-runtime",
|
|
3
|
-
"version": "1.0.0",
|
|
4
|
-
"description": "Runtime-complete Codex Doctor sample plugin with MCP validation coverage.",
|
|
5
|
-
"skills": "./skills/",
|
|
6
|
-
"mcpServers": "./.mcp.json"
|
|
7
|
-
}
|
|
8
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "codex-doctor-runtime",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Runtime-complete Codex Doctor sample plugin with MCP validation coverage.",
|
|
5
|
+
"skills": "./skills/",
|
|
6
|
+
"mcpServers": "./.mcp.json"
|
|
7
|
+
}
|
|
8
|
+
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
{
|
|
2
|
-
"mcpServers": {
|
|
3
|
-
"doctorRuntime": {
|
|
4
|
-
"command": "node",
|
|
5
|
-
"args": ["./mock-server.js"]
|
|
6
|
-
}
|
|
7
|
-
}
|
|
8
|
-
}
|
|
9
|
-
|
|
1
|
+
{
|
|
2
|
+
"mcpServers": {
|
|
3
|
+
"doctorRuntime": {
|
|
4
|
+
"command": "node",
|
|
5
|
+
"args": ["./mock-server.js"]
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
|