annal: Instructions file for Claude Code

CLAUDE.md

annal CLAUDE.md is an instructions file for Claude Code from heyhayes/annal. It costs 480 tokens per session, scanned A, original, MIT.

Project instructions for Annal, a Python server that stores and retrieves semantic memories for AI agent teams. It indexes files, keeps embeddings in a local database and can be run and tested with documented commands.

In plain words
What is it for?
Use it when installing Annal, running its tests or server, navigating its source files and following its type-hinting and development conventions.
Why use it?
It gives coding agents the project structure, setup steps, commands and code standards needed to work on the server consistently.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

This is heyhayes/annal's own configuration. It tells Claude Code how to work on annal 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 annal configures →

Reuse

Borrowing it

Nothing to install: this file belongs to heyhayes/annal. 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/heyhayes/annal/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/heyhayes/annal

Made for: Claude Code.

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 annal CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/heyhayes/annal/claude-md.svg)](https://agentmods.dev/instructions/heyhayes/annal/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/heyhayes/annal/claude-md"><img src="https://agentmods.dev/badge/instructions/heyhayes/annal/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 480 This file is loaded in full into every session.
When invoked 480 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.00480 $0.00480
Opus 5 $0.00240 $0.00240
Sonnet 5 $0.00096 $0.00096
Haiku 4.5 $0.00048 $0.00048

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

Security

Grade A, and why

annal CLAUDE.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 6d 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.

CLAUDE.md · 58 lines

What it actually says

Annal — Semantic Memory MCP Server

What This Is

A standalone Python MCP server that provides semantic memory storage and retrieval for AI agent teams. Uses ChromaDB with local ONNX embeddings. Project-agnostic — designed to work across any codebase.

Project Structure

annal/
├── src/annal/          # Package source
│   ├── __init__.py
│   ├── server.py       # MCP server entry point (FastMCP)
│   ├── config.py       # YAML config management
│   ├── store.py        # ChromaDB wrapper
│   ├── indexer.py       # File chunking (markdown by headings, config as single chunks)
│   └── watcher.py      # File watcher (watchdog + startup reconciliation)
├── tests/              # pytest tests
├── docs/plans/         # Design doc and implementation plan
└── pyproject.toml      # Project config (hatchling build)

Commands

# Install (editable with dev deps)
pip install -e ".[dev]"

# Run tests
pytest -v

# Run single test file
pytest tests/test_store.py -v

# Run the server (stdio mode)
python -m annal.server

Tech Stack

  • Python 3.12, FastMCP (mcp SDK), ChromaDB (ONNX default embeddings), watchdog, PyYAML, pytest

Code Standards

  • Type hints on all function signatures
  • Docstrings on public functions
  • Tests for every module (TDD — write tests first)
  • No print() to stdout (breaks MCP stdio transport) — use logging to stderr

Architecture Notes

  • ChromaDB PersistentClient stores data at ~/.annal/data by default
  • Collections namespaced by project: annal_{project_name}
  • Tags stored as JSON strings in ChromaDB metadata (ChromaDB doesn't natively support list metadata)
  • File-indexed chunks use source: file:{path}|{heading} format for identification
  • Tag filtering is post-query (search over-fetches then filters) due to ChromaDB metadata limitations
  • Lazy store initialization — created on first tool call, not at server startup
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. 6d ago First seen · 58 lines · 480 tokens per session scan A 81f995a58b43

Subscribe to this mod's changes

annal CLAUDE.md is an instructions file published in the GitHub repository heyhayes/annal (0 stars, last pushed 6mo ago), licensed MIT. It adds 480 tokens to every session, about $0.0024 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

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

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

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

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

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

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