OpenKB AGENTS.md

A set of instructions for coding agents working on OpenKB, a tool that turns documents into a linked, searchable knowledge base.

In plain words
What is it for?
Use it to find the relevant OpenKB modules and run installation, tests, linting, formatting, and type checks.
Why use it?
It gives agents a map of the project, its development commands, and rules they must preserve when making changes.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/vectifyai/openkb/agents-md
Clone the repo
git clone --depth 1 https://github.com/VectifyAI/OpenKB

Made for: Codex, OpenCode.

Per session 681 This file is loaded in full into every session.
When invoked 681 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00681 $0.00681
Opus 5 $0.00341 $0.00341
Sonnet 5 $0.00136 $0.00136
Haiku 4.5 $0.00068 $0.00068

Measured 3d ago against content hash 422008697557, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

OpenKB AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 45 lines

How it starts

The opening of the file, as written. The whole thing — 45 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — OpenKB map for coding agents

OpenKB compiles raw documents into an interlinked wiki knowledge base using LLMs (vectorless retrieval via PageIndex). This repo is developed agent-first: humans steer, agents execute. Optimize changes for agent legibility.

  • docs/golden-principles.md — mechanical rules to follow (enforced where possible).
  • docs/internal/superpowers/{specs,plans}/ — design history & plans (maintainer-local, not in git).
  • README.md — user-facing overview and commands.

Dev commands

  • Install: pip install -e ".[dev]" (or uv sync --extra dev — plain uv sync skips the dev tools)
  • Run CLI: openkb <command> (entry point: openkb.cli:cli)
  • Test: pytest
  • Lint/format/types: ruff check . · ruff format . · mypy openkb

Module map (openkb/)

  • cli.py — Click CLI entry point & command wiring (large; see tech-debt).
  • config.py — config loading/validation (LiteLLM passthrough, env).
  • converter.py — document → markdown conversion (markitdown).
  • url_ingest.py — fetch & ingest URLs (trafilatura).
  • images.py — figure/image extraction & handling.
  • indexer.py — PageIndex tree indexing for long docs.
  • mutation.py — crash-safe, serial KB mutations.
  • locks.py — atomic writes / file locking (atomic_write_text, portalocker).
  • state.py — run/session state tracking.
  • frontmatter.py — YAML frontmatter round-trip (OKF).
  • schema.py — page/content schema constants & helpers.
  • lint.py — structural wiki lint (broken links, orphans, index sync).
  • tree_renderer.py, visualize.py, watcher.py — rendering / graph / file watch.
  • agent/compiler.py — LLM wiki compiler (large; see tech-debt).
  • agent/linter.py — semantic (LLM) wiki lint (contradictions, gaps, staleness).
  • agent/chat.py, agent/chat_session.py — chat over the wiki (chat.py large).
  • agent/query.py — one-off query generator.
  • agent/tools.py — shared wiki read/write tool functions used by query/linter (and by chat indirectly via query.build_chat_agent).
  • agent/skills.py, agent/skill_runner.py, skill/ — Skill Factory.
  • deck/, templates/, prompts/ — deck output, templates, prompt assets.

Read the full file on GitHub · 45 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 45 lines · 681 tokens per session scan A 422008697557

Subscribe to this mod's changes

OpenKB AGENTS.md is an instructions file published in the GitHub repository VectifyAI/OpenKB (4,378 stars, last pushed 1mo ago), licensed Apache-2.0. It adds 681 tokens to every session, about $0.0034 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.