agent-brain AGENTS.md

Repository instructions for Agent Brain, a system that indexes documents and provides meaning-based search. The repository is a monorepo, meaning several related packages are kept and developed together.

In plain words
What is it for?
Use it when modifying Agent Brain's server, command-line tool, or agent skill, or when installing dependencies, building packages, or recording plans.
Why use it?
It gives coding agents the project background, required tools, installation rules, and planning expectations needed to work consistently.

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/spillwavesolutions/agent-brain/agents-md
Clone the repo
git clone --depth 1 https://github.com/SpillwaveSolutions/agent-brain

Made for: Codex, OpenCode.

Per session 2,241 This file is loaded in full into every session.
When invoked 2,241 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.02241 $0.02241
Opus 5 $0.01120 $0.01120
Sonnet 5 $0.00448 $0.00448
Haiku 4.5 $0.00224 $0.00224

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

Security

Grade A, and why

agent-brain 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 2d 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 · 267 lines

How it starts

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

Agent Brain Agent Guidelines

Instructions for AI agents (Cursor, Windsurf, OpenCode, etc.) when working on this repository.

Planning rule: after any planning step, save the plan to docs/plans/<name>.md before doing work.

Project Overview

Agent Brain is a RAG-based document indexing and semantic search system. It's a monorepo containing:

Package Path Description
agent-brain-server agent-brain-server/ FastAPI REST API server
agent-brain-cli agent-brain-cli/ CLI management tool
agent-brain-skill agent-brain-skill/ Claude Code skill

Technology Stack

  • Python: 3.10+
  • Build System: Poetry
  • Package Installer: uv (preferred over pip)
  • Server: FastAPI + Uvicorn
  • CLI: Click + Rich
  • Vector Store: ChromaDB
  • Embeddings: OpenAI text-embedding-3-large
  • Indexing: LlamaIndex

Package Installation

IMPORTANT: Always use uv instead of pip for installing packages. It's faster and handles dependencies better.

# Build packages
cd agent-brain-server && poetry build
cd agent-brain-cli && poetry build

# Install with uv (NOT pip)
uv pip install dist/agent_brain_rag-*.whl --force-reinstall
uv pip install dist/agent_brain_cli-*.whl --force-reinstall

Build and Test Commands

agent-brain-server

cd agent-brain-server
poetry install                    # Install dependencies
poetry run agent-brain-serve      # Run server
poetry run pytest                 # Run tests
poetry run pytest --cov=agent_brain_server       # Tests with coverage
poetry run mypy agent_brain_server               # Type checking
poetry run ruff check agent_brain_server         # Linting
poetry run black agent_brain_server              # Format code

agent-brain-cli

cd agent-brain-cli
poetry install                    # Install dependencies
poetry run agent-brain --help     # Show CLI help
poetry run pytest                 # Run tests
poetry run mypy agent_brain_cli               # Type checking
poetry run ruff check agent_brain_cli         # Linting
poetry run black agent_brain_cli              # Format code

Read the full file on GitHub · 267 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. 2d ago First seen · 267 lines · 2,241 tokens per session scan A d5ca7aff08eb

Subscribe to this mod's changes

agent-brain AGENTS.md is an instructions file published in the GitHub repository SpillwaveSolutions/agent-brain (117 stars, last pushed 2d ago), licensed MIT. It adds 2,241 tokens to every session, about $0.0112 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.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens