What is OpenKB AGENTS.md?

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

Use it to find the relevant OpenKB modules and run installation, tests, linting, formatting, and type checks.

It gives agents a map of the project, its development commands, and rules they must preserve when making changes.

How VectifyAI/OpenKB configures Codex and OpenCode

About the project

OpenKB is a command-line system that turns documents and other sources into a structured, linked wiki-style knowledge base using large language models. It is for organizing and retrieving information from long, varied documents, while the catalogue entries provide skills and instructions for working with it.

VectifyAI/OpenKB · 4,852 stars · on GitHub · pageindex.ai

Reuse

Borrowing it

Nothing to install: this file belongs to VectifyAI/OpenKB. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/VectifyAI/OpenKB/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/VectifyAI/OpenKB

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/vectifyai/openkb/agents-md/github.svg)](https://agentmods.dev/instructions/vectifyai/openkb/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/vectifyai/openkb/agents-md"><img src="https://agentmods.dev/badge/instructions/vectifyai/openkb/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/vectifyai/openkb/agents-md"><img src="https://agentmods.dev/badge/instructions/vectifyai/openkb/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00681	$0.00681
Opus 5.5	$0.00272	$0.00272
Sonnet 5.5	$0.00136	$0.00136
Haiku 4.5	$0.00068	$0.00068

Measured 2mo ago against content hash 422008697557, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 2mo 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.

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.

2mo 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,852 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 681 tokens to every session, about $0.0027 per session on Opus 5.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.

LLM agents ai knowledge-base retrieval

OpenKB AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
OpenKB AGENTS.mdVectifyAI/OpenKB	Instructions file	4.9k	3mo ago	Apache-2.0	A	681	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,516	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

OpenKB: Instructions file for Codex