Commit 9d1db0e
committed
docs(skill): tighten references, fix marketplace spec, add per-CLI install
Three rounds of cleanup driven by review feedback:
1. **`.openkb/` internal state hidden from references**
`wiki-schema.md` previously detailed `config.yaml`, `hashes.json`,
and `pageindex.db` schemas in the directory tree — inviting agents
to bypass the public `openkb status` / `openkb list` interface and
couple to internal storage that may change. Replaced with a single
line: "Internal openkb state lives at `<kb-root>/.openkb/`. **Do
not read these directly** — use `openkb status` / `openkb list`."
2. **References trimmed (~33% smaller, more focused)**
- `commands.md` 3.1KB → 2.2KB: dropped verbose example outputs
(full multi-line `openkb list`, `openkb status`, `openkb query`
captures) in favor of minimal shape examples. Merged the
"NOT typically needed" + "Write commands — DO NOT run" sections
so the agent has one clear safety list.
- `wiki-schema.md` 5.7KB → 3.7KB: dropped the `.openkb/` subtree
and the full `hashes.json` schema (internal). Trimmed long
directory tree to category lines only. Kept the frontmatter
YAML examples since those ARE the contract.
3. **`marketplace.json` polished per Claude Code spec**
- Renamed top-level `name: "openkb"` → `name: "openkb-marketplace"`
so users type `/plugin install openkb@openkb-marketplace` instead
of the awkward `openkb@openkb`. Mirrors Anthropic's pattern
(marketplace `anthropic-agent-skills`, plugin `document-skills`).
- Swapped `owner.url` for `owner.email` (the idiomatic field).
- Added `version`, `author`, `homepage`, `repository`, `license`,
`keywords` on the plugin entry. None required by spec but all
low-effort polish that helps discovery.
4. **README install section now per-CLI**
Three separate snippets:
- Claude Code: `/plugin marketplace add VectifyAI/OpenKB` then
`/plugin install openkb@openkb-marketplace`.
- Gemini CLI: `gemini skills install <repo> --path skills/openkb`
— native installer reads our `skills/` tree directly.
- Codex CLI: manual `git clone` + symlink into `~/.agents/skills/`.
Codex has no marketplace mechanism today; `.agents/skills/` is
its discovery path. Once a Codex marketplace ships, the same
`marketplace.json` will likely work.1 parent 9fe94e3 commit 9d1db0e
4 files changed
Lines changed: 132 additions & 233 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
17 | 26 | | |
18 | 27 | | |
19 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
240 | 240 | | |
241 | 241 | | |
242 | 242 | | |
243 | | - | |
244 | | - | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
245 | 246 | | |
246 | | - | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
247 | 251 | | |
248 | | - | |
249 | | - | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
250 | 262 | | |
251 | 263 | | |
252 | | - | |
| 264 | + | |
253 | 265 | | |
254 | | - | |
| 266 | + | |
255 | 267 | | |
256 | 268 | | |
257 | 269 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 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 | | - | |
| 3 | + | |
| 4 | + | |
43 | 5 | | |
44 | 6 | | |
45 | 7 | | |
46 | | - | |
47 | | - | |
48 | | - | |
| 8 | + | |
| 9 | + | |
49 | 10 | | |
50 | 11 | | |
51 | 12 | | |
52 | 13 | | |
53 | | - | |
54 | 14 | | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
| 15 | + | |
66 | 16 | | |
67 | 17 | | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
75 | 21 | | |
76 | | - | |
| 22 | + | |
77 | 23 | | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
83 | 28 | | |
84 | 29 | | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
92 | 39 | | |
93 | 40 | | |
94 | | - | |
95 | | - | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
96 | 48 | | |
97 | | - | |
| 49 | + | |
98 | 50 | | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | | - | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
103 | 55 | | |
104 | | - | |
| 56 | + | |
105 | 57 | | |
106 | | - | |
| 58 | + | |
| 59 | + | |
107 | 60 | | |
108 | | - | |
| 61 | + | |
109 | 62 | | |
110 | 63 | | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
| 64 | + | |
| 65 | + | |
118 | 66 | | |
119 | | - | |
120 | | - | |
121 | | - | |
122 | | - | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
0 commit comments