open/llm-ingestion-okf
1
0
Fork 0
Code Issues Releases 4 Activity

docs(project): the server is the standard way in, the skill the supplement

Browse source 
`okf project`'s closing text and the README's first screen now say it in
that order: register `okf mcp --root` once, and it answers from every
project and reaches subagents; the skill beside the bundle is for someone
who would rather register nothing; neither is made again when a bundle is
rebuilt. Two tests hold the order in both places. The README's stale
`<id>-consume` skill path is corrected to `okf-consume-any`.

v1.1 order F, part F3.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Kjell Tore Guttormsen 2026-09-21 10:36:52 +02:00
commit 570496470b
5 changed files with 56 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -16,22 +16,23 @@ uv tool install "llm-ingestion-okf[extract] @ git+https://git.fromaitochitta.com
## Use it
```sh
okf project ~/my-documents # folder in: bundle + Claude Code skill, in this directory
claude # start Claude Code here
okf project ~/my-documents # folder in: a bundle under ./.okf, and a skill beside it
```
**Or connect every bundle at once.** Register the server once, on user scope,
and every project you open can ask any bundle under that directory — no skill
to install per project, and nothing to regenerate when a bundle is rebuilt.
You run this line; `okf` never starts Claude Code:
**The standard way in is the server.** Register it once, on user scope,
pointing at the directory that holds your projects. Every project you open can
then ask any bundle under it, subagents included — they inherit MCP tools and
not skills — and a bundle added or rebuilt is seen by the next call. You run
this line; `okf` never starts Claude Code:
```sh
claude mcp add --scope user okf -- okf mcp --root ~/okf
claude mcp add --scope user okf -- okf mcp --root ~/projects
```
Subagents inherit MCP tools and do not inherit skills, so the server is also
the only way the same working method reaches an arm running below the main
thread.
**The skill is the supplement**, for when you would rather register nothing:
`okf project` writes it beside the bundle, so starting `claude` in that
directory is enough. It reads every bundle under `./.okf` with the same code the
server runs. Neither has to be made again when a bundle is rebuilt.
Then ask in plain language. Three shapes of request work, and the skill states
the rules for each:
@ -1236,7 +1237,7 @@ claude
```
`okf project` writes the bundle to `.okf/<id>/` and a skill to
`.claude/skills/<id>-consume/` in the **current directory**, then prints what it
`.claude/skills/okf-consume-any/` in the **current directory**, then prints what it
read, what it wrote, and which documents a question cannot reach. Start `claude`
in that directory and ask in plain language; the generated skill runs the
pre-pass and the contract check itself and marks every claim with its source.