private-journal-mcp: Instructions file for Claude Code

CLAUDE.md

private-journal-mcp CLAUDE.md is an instructions file for Claude Code from obra/private-journal-mcp. It costs 755 tokens per session, scanned A, original, MIT.

Repository instructions for an AI coding agent working on a private journaling server for Claude. They explain the project structure and list commands for building, testing, watching tests, linting, formatting, and starting the server.

In plain words
What is it for?
Use them when modifying the journaling server, its TypeScript files, journal storage, search tools, or development commands.
Why use it?
They provide the project’s expected workflow and architecture in one place. This reduces guesswork when making changes or checking whether they work.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

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

About the project

obra/private-journal-mcp is an MCP server that gives Claude a local journal for recording and searching thoughts, reflections, notes, and insights. It is intended for private personal and project journaling, with semantic search performed on the user's machine. The catalogue instruction helps coding agents use its journaling workflow.

obra/private-journal-mcp · 442 stars · on GitHub

Reuse

Borrowing it

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

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 private-journal-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/obra/private-journal-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/obra/private-journal-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/obra/private-journal-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/obra/private-journal-mcp/claude-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 private-journal-mcp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/obra/private-journal-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/obra/private-journal-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 755 This file is loaded in full into every session.
When invoked 755 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.00755 $0.00755
Opus 5 $0.00378 $0.00378
Sonnet 5 $0.00151 $0.00151
Haiku 4.5 $0.00076 $0.00076

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

Security

Grade A, and why

private-journal-mcp 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 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.

CLAUDE.md · 81 lines

How it starts

The opening of the file, as written. The whole thing — 81 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.

Common Development Commands

# Build the project
npm run build

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

# Development mode with TypeScript watcher
npm run dev

# Lint the code
npm run lint

# Format the code
npm run format

# Start the server
npm start

# Run a single test file
npx jest tests/journal.test.ts

Architecture Overview

This is an MCP (Model Context Protocol) server that provides Claude with private journaling capabilities. The architecture consists of:

Core Components:

  • src/index.ts - CLI entry point with intelligent path resolution for journal storage
  • src/server.ts - MCP server using stdio transport with private journaling and search tools
  • src/journal.ts - File system operations for timestamped markdown entries
  • src/types.ts - TypeScript interfaces for the domain model

Key Architecture Patterns:

  • Path Resolution Strategy: PRIVATE_JOURNAL_PATH env var overrides all resolution; otherwise falls back through CWD → HOME → temp directories, avoiding system roots
  • Timestamped Storage: Uses YYYY-MM-DD/HH-MM-SS-μμμμμμ.md structure with microsecond precision
  • YAML Frontmatter: Each entry includes structured metadata (title, ISO date, Unix timestamp)
  • MCP Tool Pattern: Tool registration with schema validation and error handling

File Organization:

  • Project journals: .private-journal/ in project root for project-specific notes
  • Personal journals: ~/.private-journal/ for cross-project personal thoughts
  • Daily structure: YYYY-MM-DD/HH-MM-SS-μμμμμμ.md with microsecond precision
  • Search index: .embedding files alongside each journal entry for semantic search
  • TypeScript compilation to dist/ for production
  • Jest tests in tests/ directory with comprehensive file system mocking

MCP Integration Details

The server provides comprehensive journaling and search capabilities through these tools:

Read the full file on GitHub · 81 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 · 81 lines · 755 tokens per session scan A 71721f8ac915

Subscribe to this mod's changes

private-journal-mcp CLAUDE.md is an instructions file published in the GitHub repository obra/private-journal-mcp (442 stars, last pushed 28d ago), licensed MIT. It adds 755 tokens to every session, about $0.0038 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

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