pdf-brain AGENTS.md

Repository instructions for pdf-brain, including its database behavior, vector search details, and preferred software patterns.

In plain words
What is it for?
Use them when working on pdf-brain, especially its libSQL database, embeddings, vector indexes, or AI SDK code.
Why use it?
They warn coding agents about project-specific database quirks and storage costs that may otherwise cause errors.

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

Made for: Codex, OpenCode.

Per session 531 This file is loaded in full into every session.
When invoked 531 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.00531 $0.00531
Opus 5 $0.00266 $0.00266
Sonnet 5 $0.00106 $0.00106
Haiku 4.5 $0.00053 $0.00053

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

Security

Grade A, and why

pdf-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 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 · 63 lines

How it starts

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

pdf-brain Agent Notes

libSQL Quirks

COUNT(*) returns 0 for vector tables - libSQL's vector extension has a quirk where SELECT COUNT(*) FROM embeddings returns 0. Always count a specific column instead:

-- WRONG: returns 0
SELECT COUNT(*) FROM embeddings

-- CORRECT: returns actual count
SELECT COUNT(chunk_id) FROM embeddings

Vector index shadow tables are MASSIVE - The *_idx_shadow tables store neighbor graphs for HNSW search. Each row averages ~100KB. For 500k embeddings, expect ~48GB just for the index.

┌─────────────────────────────────────────────────────────────────────┐
│                    DB SIZE BREAKDOWN (500k chunks)                  │
├─────────────────────────────────────────────────────────────────────┤
│  embeddings_idx_shadow    ~48GB (92%)  - HNSW neighbor graphs       │
│  embeddings               ~1.9GB (4%)  - 500k × 1024 dims × 4 bytes │
│  chunks                   ~180MB (<1%) - actual text content        │
│  chunks_fts               ~200MB       - full-text search index     │
└─────────────────────────────────────────────────────────────────────┘

Potential optimizations:

  • Use compress_neighbors=float8 in index (already enabled)
  • Consider smaller embedding models (384 dims vs 1024)
  • Batch similar documents to reduce total chunks
  • Use partial indexing (only index recent/important docs)

AI SDK Pattern

Use the simple model string pattern with Vercel AI Gateway:

import { generateObject } from "ai";
import { z } from "zod";

const { object } = await generateObject({
  model: "anthropic/claude-haiku-4-5",
  schema: MyZodSchema,
  prompt: "...",
});

No provider setup needed - uses AI_GATEWAY_API_KEY env var automatically.

Key Files

  • src/services/LibSQLDatabase.ts - Database layer with Effect
  • src/services/AutoTagger.ts - LLM enrichment logic
  • src/services/TaxonomyService.ts - SKOS concept management
  • src/cli.ts - CLI commands
  • data/taxonomy.json - Starter taxonomy seed data

Read the full file on GitHub · 63 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 · 63 lines · 531 tokens per session scan A 6f2a3b4e631e

Subscribe to this mod's changes

pdf-brain AGENTS.md is an instructions file published in the GitHub repository joelhooks/pdf-brain (653 stars, last pushed 2mo ago), licensed MIT. It adds 531 tokens to every session, about $0.0027 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

GPT-RAG config-python.instructions.md

Instructions for Azure/GPT-RAG, a project described as: Sharing the learning along the way we been gathering to enable Azure OpenAI at enterprise scale in a secure manner. GPT-RAG core is a Retrieval-Augmented Generation pattern running in Azure, using Azure Cognitive Search for retrieval and Azure OpenAI large…

Azure/GPT-RAG · 180 tokens

GPT-RAG release.instructions.md

Instructions for Azure/GPT-RAG, a project described as: Sharing the learning along the way we been gathering to enable Azure OpenAI at enterprise scale in a secure manner. GPT-RAG core is a Retrieval-Augmented Generation pattern running in Azure, using Azure Cognitive Search for retrieval and Azure OpenAI large…

Azure/GPT-RAG · 207 tokens

rag-code-mcp copilot-instructions.md

Instructions for doITmagic/rag-code-mcp, covering copilot instructions - ragcode mcp, ⚖️ the golden rule, project overview, architecture & patterns and developer workflows.

doITmagic/rag-code-mcp · 568 tokens

gpt-rag-mcp AGENTS.md

Instructions for Azure/gpt-rag-mcp, covering gpt-rag mcp engineering-agent contract, priority, what this repository is, repository boundaries and how to work.

Azure/gpt-rag-mcp · 1,862 tokens

gemini-cli-extension GEMINI.md

Instructions for pinecone-io/gemini-cli-extension, covering pinecone extension for gemini cli, available agent skills, key concepts & setup and available mcp tools.

pinecone-io/gemini-cli-extension · 569 tokens

ragdocs-mcp copilot-instructions.md

Copilot instructions for andnp/ragdocs-mcp, covering github copilot instructions for mcp-markdown-ragdocs, project overview, technology stack, architecture and project layout.

andnp/ragdocs-mcp · 1,800 tokens