OpenNotebookLM: Instructions file for Codex

AGENTS.md

OpenNotebookLM AGENTS.md is an instructions file for Codex, OpenCode from tom1030507/OpenNotebookLM. It costs 1,612 tokens per session, scanned A, original, MIT.

A repository instruction guide for OpenNotebookLM, describing its backend and frontend layout, development commands, coding conventions, and testing rules.

In plain words
What is it for?
Guiding changes, tests, and maintenance across the FastAPI backend, Next.js frontend, database code, scripts, deployment files, and evaluation tests.
Why use it?
It helps an agent work in the live parts of the project and avoid extending an unused duplicate application area.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is tom1030507/OpenNotebookLM's own configuration. It tells Codex and OpenCode how to work on OpenNotebookLM itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything OpenNotebookLM configures →

Reuse

Borrowing it

Nothing to install: this file belongs to tom1030507/OpenNotebookLM. 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/tom1030507/OpenNotebookLM/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/tom1030507/OpenNotebookLM

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.

agentmods badge for OpenNotebookLM AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/tom1030507/opennotebooklm/agents-md/github.svg)](https://agentmods.dev/instructions/tom1030507/opennotebooklm/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/tom1030507/opennotebooklm/agents-md"><img src="https://agentmods.dev/badge/instructions/tom1030507/opennotebooklm/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.

agentmods 80×15 button for OpenNotebookLM AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/tom1030507/opennotebooklm/agents-md"><img src="https://agentmods.dev/badge/instructions/tom1030507/opennotebooklm/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,612 This file is loaded in full into every session.
When invoked 1,612 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.01612 $0.01612
Opus 5 $0.00806 $0.00806
Sonnet 5 $0.00322 $0.00322
Haiku 4.5 $0.00161 $0.00161

Measured 9d ago against content hash b4049efd8aa3, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

OpenNotebookLM 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 9d 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 · 134 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

backend/app/ is the FastAPI application: HTTP routes in routers/, business logic in services/, source importers in adapters/, SQLAlchemy models and column types in db/, shared helpers in utils/. Keep routers thin — they validate, delegate to a service, and shape the response.

backend/scripts/ holds operational scripts, run as python -m scripts.<name> from /app. backend/tests/ has API and lifecycle tests, backend/tests/unit/ focused ones, and backend/tests/eval/ the retrieval evaluation dataset.

frontend/ is a Next.js app: routes in app/, reusable UI in components/, hooks in hooks/, Zustand stores in store/, API client and session handling in lib/.

Deployment lives in deploy/ and the root docker-compose.yml.

Two traps in the layout:

  • The root-level app/ (app/adapters/sqlite_vec.py, app/services/monitoring.py, app/routers/monitoring.py) is orphaned. Nothing imports it, and sqlite_vec.py does not use sqlite-vec despite the name. Do not extend it; the live code is under backend/app/.
  • docs/ is gitignored. Anything you want tracked belongs in README.md or in a module docstring, not in docs/.

Build, Test, and Development Commands

  • docker compose up -d --build runs the stack: backend on :8000, frontend on :3000. Optional services via --profile with-ollama or --profile with-cache.
  • cd backend && pip install -r requirements.txt then python -m uvicorn app.main:app --reload runs the API outside Docker.
  • cd frontend && npm ci && npm run dev starts Next.js. npm run build for a production build, npm run lint for ESLint.
  • docker exec <backend-container> sh -lc "cd /app && python -m pytest tests -q" runs the backend suite.
  • cd frontend && npm test runs vitest.

The backend suite needs the ML dependencies importable. app.services.embeddings imports sentence_transformers and torch at module scope, so a bare virtualenv cannot even collect the tests — in practice the container is the place to run them. backend/tests/unit/test_config.py additionally walks up to the repo root for the .env.example files, so run it with the repo root available, not just backend/ mounted.

Read the full file on GitHub · 134 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. 9d ago First seen · 134 lines · 1,612 tokens per session scan A b4049efd8aa3

Subscribe to this mod's changes

OpenNotebookLM AGENTS.md is an instructions file published in the GitHub repository tom1030507/OpenNotebookLM (46 stars, last pushed 3d ago), licensed MIT. It adds 1,612 tokens to every session, about $0.0081 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

next.js AGENTS.md

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

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,153 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

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

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,469 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens