{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 275
Expand file tree
/
Copy pathvalidate_codex_plugin.py
More file actions
executable file
·287 lines (265 loc) · 11.6 KB
/
Copy pathvalidate_codex_plugin.py
File metadata and controls
executable file
·287 lines (265 loc) · 11.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
#!/usr/bin/env python3
"""Validate the Basic Memory Codex plugin layout."""
from __future__ import annotations
import argparse
import json
import os
import re
from pathlib import Path
from typing import Any
from validate_skills import parse_frontmatter
REQUIRED_SKILLS = (
"bm-setup",
"bm-orient",
"bm-checkpoint",
"bm-decide",
"bm-remember",
"bm-writing",
"bm-share",
"bm-status",
)
REQUIRED_SKILL_TEXT: dict[str, tuple[str, ...]] = {
"bm-setup": (
"checkpointOnCompact",
"captureEvents",
"user-level",
"project-level",
"codex/<repo-dir>",
"sessionProfile",
"coding-session.md",
"hook status --harness codex",
"Keep Codex's default approval behavior",
"Pre-approve eligible tools",
'[plugins."codex@basic-memory".mcp_servers.basic-memory]',
'default_tools_approval_mode = "approve"',
"Do not offer a per-tool or write-only trust profile",
"destructive annotation",
"writes,\nedits, and deletes may still prompt",
),
"bm-status": (
"~/.codex/basic-memory.json",
"checkpointOnCompact",
"hook status --harness codex",
"pending envelopes",
"archived envelopes",
"last flush",
"type=codex_session",
"type=coding_session",
),
"bm-orient": (
"Always query `codex_session`",
"type=codex_session",
"type=coding_session",
"Choose exactly one route",
"read that note directly",
"`project=<configured primaryProject>`",
"Do not retry the identifier against secondary or other projects",
"Run the `coding_session` topic search separately",
'metadata_filters={"repository": "<configured repository>"}',
"omit `coding_session` results",
"Treat a recovered note as historical context",
"Report material drift explicitly",
),
"bm-checkpoint": (
"Apply the `bm-writing` skill",
"A checkpoint is a durable handoff, not a status dump",
"Every invocation creates a new checkpoint",
"UTC YYYY-MM-DDTHH-MM-SSZ",
"snapshot plus pointers",
"username: <current username>",
"hostname: <current hostname>",
"type: coding_session",
"pull_request_number",
"- `[decision]` for each decision made or preserved",
"include exactly one",
"## Relations",
"- relates_to [[Exact existing note title]]",
"Never write `[relates_to]`",
"`project=<configured primaryProject>`",
"frontmatter `project` field is descriptive",
"codex_session_id",
'metadata_filters={"codex_session_id": "<exact host-provided id>"}',
"- continues [[Exact previous checkpoint title]]",
"## References",
"verify that GitHub can resolve that SHA",
"overwrite=False",
'output_format="json"',
"`write_note_overwrite_default` setting is true",
"with `action: created`",
"`file_path`, then `title`",
'$bm-orient "<exact returned resume identifier>"',
),
"bm-decide": ("codex/decisions",),
"bm-remember": ("codex/remember",),
"bm-writing": (
"intentionally user-customizable",
"problem -> approach -> current state and impact",
"## Anchor The Work",
"## Preserve The Semantic Layer",
"- relation_type [[Target Note]]",
"Do not invent intent, impact, verification, decisions, or drama",
),
}
REQUIRED_SCHEMAS = ("codex-session.md", "coding-session.md", "decision.md", "task.md")
REQUIRED_HOOKS = {
"SessionStart": "hooks/session_start.py",
"PreCompact": "hooks/pre_compact.py",
}
REQUIRED_HOOK_EVENTS = tuple(REQUIRED_HOOKS)
# Zero-logic shims: the only hook code the plugin ships. The Python bodies
# moved into the basic-memory package behind `bm hook` (SPEC-55).
REQUIRED_HOOK_SCRIPTS = tuple(REQUIRED_HOOKS.values())
REQUIRED_SKILL_AGENT_FILES = ("agents/openai.yaml", "assets/icon.svg")
REQUIRED_INTERFACE_ASSETS = {
"composerIcon": "assets/app-icon.png",
"logo": "assets/logo.png",
}
HOOK_SCRIPT_PATH_RE = re.compile(r"\$\{PLUGIN_ROOT\}/(hooks/[A-Za-z0-9_./-]+\.py)")
HOOK_DEPENDENCY_RE = re.compile(
r'"basic-memory @ git\+https://github\.com/'
r'basicmachines-co/basic-memory@([^"]+)"'
)
def read_json(path: Path) -> dict[str, Any]:
try:
payload = json.loads(path.read_text())
except FileNotFoundError:
raise SystemExit(f"Missing JSON file: {path}") from None
except json.JSONDecodeError as exc:
raise SystemExit(f"{path}: invalid JSON: {exc}") from None
if not isinstance(payload, dict):
raise SystemExit(f"{path}: expected a JSON object")
return payload
def require_path(path: Path, label: str) -> None:
if not path.exists():
raise SystemExit(f"Missing {label}: {path}")
def validate_plugin(plugin_dir: Path) -> None:
plugin_dir = plugin_dir.resolve()
# --- Manifest ---
manifest_path = plugin_dir / ".codex-plugin" / "plugin.json"
manifest = read_json(manifest_path)
if manifest.get("name") != "codex":
raise SystemExit(f"{manifest_path}: expected name=codex")
if manifest.get("skills") != "./skills/":
raise SystemExit(f"{manifest_path}: expected skills=./skills/")
if manifest.get("mcpServers") != "./.mcp.json":
raise SystemExit(f"{manifest_path}: expected mcpServers=./.mcp.json")
interface = manifest.get("interface")
if not isinstance(interface, dict):
raise SystemExit(f"{manifest_path}: missing interface object")
if interface.get("displayName") != "Basic Memory for Codex":
raise SystemExit(f"{manifest_path}: unexpected interface.displayName")
for field, expected_path in REQUIRED_INTERFACE_ASSETS.items():
if interface.get(field) != f"./{expected_path}":
raise SystemExit(f"{manifest_path}: expected interface.{field}=./{expected_path}")
require_path(plugin_dir / expected_path, f"interface.{field} asset")
# --- MCP ---
mcp = read_json(plugin_dir / ".mcp.json")
servers = mcp.get("mcpServers")
if not isinstance(servers, dict) or "basic-memory" not in servers:
raise SystemExit(".mcp.json: expected mcpServers.basic-memory")
basic_memory = servers["basic-memory"]
if not isinstance(basic_memory, dict):
raise SystemExit(".mcp.json: basic-memory server must be an object")
if basic_memory.get("command") not in {"uvx", "basic-memory", "bm"}:
raise SystemExit(".mcp.json: basic-memory server uses an unexpected command")
# --- Hooks ---
hooks_json = read_json(plugin_dir / "hooks" / "hooks.json")
hooks = hooks_json.get("hooks")
if not isinstance(hooks, dict):
raise SystemExit("hooks/hooks.json: expected hooks object")
if set(hooks) != set(REQUIRED_HOOK_EVENTS):
raise SystemExit(
"hooks/hooks.json: expected exactly these hook events: "
+ ", ".join(REQUIRED_HOOK_EVENTS)
)
for event, expected_script in REQUIRED_HOOKS.items():
matcher_groups = hooks[event]
if not isinstance(matcher_groups, list) or len(matcher_groups) != 1:
raise SystemExit(f"hooks/hooks.json: {event} must define exactly one matcher group")
matcher_group = matcher_groups[0]
command_hooks = matcher_group.get("hooks") if isinstance(matcher_group, dict) else None
if not isinstance(command_hooks, list) or len(command_hooks) != 1:
raise SystemExit(f"hooks/hooks.json: {event} must define exactly one command hook")
command_hook = command_hooks[0]
if not isinstance(command_hook, dict) or command_hook.get("type") != "command":
raise SystemExit(f"hooks/hooks.json: {event} hook must have type=command")
command = command_hook.get("command")
if not isinstance(command, str):
raise SystemExit(f"hooks/hooks.json: {event} hook must define a command")
script_refs = HOOK_SCRIPT_PATH_RE.findall(command)
if script_refs != [expected_script]:
raise SystemExit(f"hooks/hooks.json: {event} must reference exactly {expected_script}")
hook_files = {
f"hooks/{path.name}"
for path in (plugin_dir / "hooks").iterdir()
if path.is_file() and path.name != "hooks.json" and not path.name.startswith("test_")
}
if hook_files != set(REQUIRED_HOOK_SCRIPTS):
raise SystemExit(
"hooks/: expected exactly these non-test hook scripts: "
+ ", ".join(REQUIRED_HOOK_SCRIPTS)
)
dependency_refs: set[str] = set()
for rel in REQUIRED_HOOK_SCRIPTS:
script = plugin_dir / rel
require_path(script, "hook script")
if not os.access(script, os.X_OK):
raise SystemExit(f"Hook script is not executable: {script}")
text = script.read_text(encoding="utf-8")
dependency_match = HOOK_DEPENDENCY_RE.search(text)
if "# /// script" not in text or dependency_match is None:
raise SystemExit(f"Hook script missing pinned Basic Memory Git dependency: {script}")
dependency_refs.add(dependency_match.group(1))
if len(dependency_refs) != 1:
raise SystemExit("Codex hook scripts must use the same Basic Memory Git ref")
# --- Skills ---
skills_root = plugin_dir / "skills"
require_path(skills_root, "skills directory")
present = {path.name for path in skills_root.iterdir() if path.is_dir()}
for skill_name in REQUIRED_SKILLS:
if skill_name not in present:
raise SystemExit(f"Missing required skill: skills/{skill_name}/SKILL.md")
for skill_dir in sorted(path for path in skills_root.iterdir() if path.is_dir()):
skill_file = skill_dir / "SKILL.md"
require_path(skill_file, "skill file")
frontmatter = parse_frontmatter(skill_file)
if frontmatter.get("name") != skill_dir.name:
raise SystemExit(f"{skill_file}: name must match directory")
if not frontmatter.get("description"):
raise SystemExit(f"{skill_file}: missing description")
skill_text = skill_file.read_text(encoding="utf-8")
for required_text in REQUIRED_SKILL_TEXT.get(skill_dir.name, ()):
if required_text not in skill_text:
raise SystemExit(f"{skill_file}: missing plugin contract text {required_text!r}")
for rel in REQUIRED_SKILL_AGENT_FILES:
require_path(skill_dir / rel, f"skill {rel}")
# --- Schemas ---
schemas_root = plugin_dir / "schemas"
require_path(schemas_root, "schemas directory")
for schema_name in REQUIRED_SCHEMAS:
schema_file = schemas_root / schema_name
require_path(schema_file, "schema")
frontmatter = parse_frontmatter(schema_file)
if frontmatter.get("type") != "schema":
raise SystemExit(f"{schema_file}: expected type: schema")
if not frontmatter.get("entity"):
raise SystemExit(f"{schema_file}: missing entity")
readme = (plugin_dir / "README.md").read_text(encoding="utf-8")
for required_text in (
"lifecycle trace stays local",
"post-compaction `SessionStart`",
"note is agent-authored",
'[plugins."codex@basic-memory".mcp_servers.basic-memory]',
"[mcp_servers.basic-memory]",
'default_tools_approval_mode = "approve"',
):
if required_text not in readme:
raise SystemExit(f"README.md: missing schema ownership text {required_text!r}")
print(f"validated Codex plugin in {plugin_dir}")
def main() -> None:
parser = argparse.ArgumentParser()
parser.add_argument("plugin_dir", nargs="?", default="plugins/codex")
args = parser.parse_args()
validate_plugin(Path.cwd() / args.plugin_dir)
if __name__ == "__main__":
main()
You can’t perform that action at this time.