grounded-knowledge-engine AGENTS.md

Repository instructions for a local-first knowledge engine that stores Markdown files as its source material and builds a searchable index from them. It also describes how coding agents should use the project's command-line and local document tools.

In plain words
What is it for?
Answering questions from stored documents, resuming named projects, searching the knowledge base, and following the repository's architecture, authorship, attribution, and publishing rules.
Why use it?
They give agents one agreed way to work with project documents, research, decisions, and handoffs. They also prevent duplicated rules and help protect information before changes are committed publicly.

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/dimosgit/grounded-knowledge-engine/agents-md
Clone the repo
git clone --depth 1 https://github.com/dimosgit/grounded-knowledge-engine

Made for: Codex, OpenCode.

Per session 2,449 This file is loaded in full into every session.
When invoked 2,449 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.02449 $0.02449
Opus 5 $0.01224 $0.01224
Sonnet 5 $0.00490 $0.00490
Haiku 4.5 $0.00245 $0.00245

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

Security

Grade A, and why

grounded-knowledge-engine 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 yesterday.

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 · 190 lines

How it starts

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

Agent Guide

Canonical guidance for coding agents (Claude Code, Codex, Gemini CLI) working in this repository. CLAUDE.md and GEMINI.md import this file — edit here, not there.

GKE is a local-first grounded knowledge engine: Markdown files are the source of truth, the retrieval index (BM25 / SQLite FTS5) is derived and disposable, and the same engine core is exposed through a CLI, a local MCP server, and the optional Operator Cockpit web preview. This repo is public — see Sanitization below before committing anything.

Agent operating contract

This file is the repository's agent contract. Do not create a second contract file with overlapping rules.

  • Use the connected GKE MCP server first when a request depends on the user's documents, a named workspace or client, previous research, project state, decisions, or handoffs. For ordinary grounded Q&A use kb.answer_and_capture; for a named project use kb.resume_project; use kb.search only for evidence-only retrieval and kb.get_record only for an explicitly requested record.
  • Do not use GKE MCP merely to inspect or debug this repository's source code. The checked-out files and tests are authoritative for implementation work.
  • If a task should use GKE but no kb.* tools are visible, say that the MCP connection is unavailable, run npm run setup:mcp -- --client <client> when local configuration is in scope, and remind the operator that clients must be restarted to reload their tool catalog. Do not silently pretend an ungrounded answer came from GKE.
  • MCP tools are model-controlled: registration makes them available but does not force a call. These routing rules are therefore mandatory for applicable tasks.

Authorship and attribution

AI assistants are tools, not repository contributors. Never use an AI product, model, bot, or session identity as a commit author, committer, co-author, reviewer signature, or release author. Do not add AI attribution trailers such as Co-Authored-By or session links. Preserve the human operator's configured Git identity for commits unless the operator explicitly requests another human identity.

Read the full file on GitHub · 190 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. yesterday First seen · 190 lines · 2,449 tokens per session scan A ffec3f28d1e4

Subscribe to this mod's changes

grounded-knowledge-engine AGENTS.md is an instructions file published in the GitHub repository dimosgit/grounded-knowledge-engine (5 stars, last pushed 5d ago), licensed MIT. It adds 2,449 tokens to every session, about $0.0122 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-31.

Related

Other instructions, from other repositories

siyuan AGENTS.md

AGENTS.md instructions for siyuan-note/siyuan, covering agents.md, 1. non-negotiable constraints, do not hand-edit, verification and prohibited operations and 2. project-specific rules.

siyuan-note/siyuan · 4,668 tokens

obsidian-mcp-server AGENTS.md

Instructions for cyanheads/obsidian-mcp-server, covering agent protocol, what's next?, core rules, patterns and tool — obsidianlisttags.

cyanheads/obsidian-mcp-server · 6,725 tokens

Starcat AGENTS.md

Instructions for starcat-app/Starcat, covering agents.md, 🚨 硬性铁律(每次写代码前必读,违反即返工), 🌿 git 分支与 worktree(强制), 🧭 主进度索引(每次开工前必读) and 状态符号(与功能实现总览.md 同步).

starcat-app/Starcat · 7,077 tokens

Starcat CLAUDE.md

Instructions for starcat-app/Starcat, covering claude.md, 🚨 硬性铁律(每次写代码前必读,违反即返工), 🌿 git 分支与 worktree(强制), 🧭 主进度索引(每次开工前必读) and 状态符号(与功能实现总览.md 同步).

starcat-app/Starcat · 6,398 tokens

Vault-Agent-Memory AGENTS.md

Instructions for zycaskevin/Vault-Agent-Memory, covering agent instructions for vault agent memory, common install architecture, second decision: optional features, first decision: database scope and safe agent workflow.

zycaskevin/Vault-Agent-Memory · 1,618 tokens

my-wiki AGENTS.md

Instructions for NimaChu/my-wiki, covering my wiki agent project, project map, knowledge model, route requests and development checks.

NimaChu/my-wiki · 617 tokens