notes CLAUDE.md

A set of development instructions for the cardmagic/notes project, a tool that searches and manages Apple Notes from the command line or through MCP. It documents the project's commands, structure, and data flow.

In plain words
What is it for?
Use it when developing the notes project, including running its checks, understanding its CLI and MCP entry points, or working on AppleScript, indexing, search, and formatting code.
Why use it?
It gives Claude Code the project-specific guidance needed to build, test, lint, and change the repository consistently.

Instructions file

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/cardmagic/notes/claude-md
Clone the repo
git clone --depth 1 https://github.com/cardmagic/notes
Per session 747 This file is loaded in full into every session.
When invoked 747 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.00747 $0.00747
Opus 5 $0.00374 $0.00374
Sonnet 5 $0.00149 $0.00149
Haiku 4.5 $0.00075 $0.00075

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

Security

Grade A, and why

notes 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 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.

CLAUDE.md · 82 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

pnpm build          # Compile TypeScript to dist/
pnpm dev            # Watch mode for development
pnpm typecheck      # Type check without emitting
pnpm lint           # Run oxlint
pnpm test           # Run tests
pnpm test:watch     # Run tests in watch mode

make install        # Build and link globally
make clean          # Remove dist/ and node_modules/

Architecture

Dual-mode CLI/MCP tool for searching and managing Apple Notes:

src/
├── index.ts       # Entry point - routes to CLI or MCP mode based on --mcp flag
├── cli.ts         # Commander-based CLI (search, recent, folders, read, create, delete commands)
├── mcp.ts         # MCP server exposing tools via @modelcontextprotocol/sdk
├── applescript.ts # AppleScript automation for create/delete operations
├── indexer.ts     # Builds search indexes from Apple Notes database
├── searcher.ts    # Queries indexes with fuzzy matching via MiniSearch
├── formatter.ts   # Terminal output formatting with chalk
└── types.ts       # Shared types and Apple date conversion utilities

Data flow:

  1. indexer.ts reads Apple's NoteStore.sqlite database from ~/Library/Group Containers/group.com.apple.notes/
  2. Extracts text from gzipped note body data (protobuf-like format)
  3. Creates two indexes in ~/.notes/: FTS5 SQLite for exact search, MiniSearch JSON for fuzzy matching
  4. searcher.ts queries MiniSearch for fuzzy results, then fetches full data from SQLite

Key dependencies:

  • better-sqlite3: Read Apple Notes DB and create FTS5 index
  • minisearch: Fuzzy search with typo tolerance
  • @modelcontextprotocol/sdk: MCP server for Claude Code integration

Claude Code Plugin

This repo is also a Claude Code plugin with skills and slash commands:

.claude-plugin/
├── plugin.json       # Plugin manifest
└── marketplace.json  # Marketplace definition (name: cardmagic)

skills/notes/SKILL.md    # Auto-invoked skill for note queries
commands/
├── search.md            # /notes:search slash command
├── recent.md            # /notes:recent slash command
├── folders.md           # /notes:folders slash command
├── folder.md            # /notes:folder slash command
├── read.md              # /notes:read slash command
├── create.md            # /notes:create slash command
└── delete.md            # /notes:delete slash command

Read the full file on GitHub · 82 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 · 82 lines · 747 tokens per session scan A d314348e5ad7

Subscribe to this mod's changes

notes CLAUDE.md is an instructions file published in the GitHub repository cardmagic/notes (4 stars, last pushed 6d ago), licensed MIT. It adds 747 tokens to every session, about $0.0037 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

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

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

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