What is joplin-mcp-server CLAUDE.md?

A coding guide for a TypeScript server that connects AI tools to Joplin, a note-taking app. It explains the server’s structure, commands, and main components.

Use it when changing or maintaining the Joplin server, especially when working with notes, notebooks, its REST API, or its standard input and HTTP connections.

It gives an coding agent the project context needed to work consistently, including how to build, check, format, lint, and test the code.

How jordanburke/joplin-mcp-server configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to jordanburke/joplin-mcp-server. 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/jordanburke/joplin-mcp-server/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/jordanburke/joplin-mcp-server

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/jordanburke/joplin-mcp-server/claude-md/github.svg)](https://agentmods.dev/instructions/jordanburke/joplin-mcp-server/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/jordanburke/joplin-mcp-server/claude-md"><img src="https://agentmods.dev/badge/instructions/jordanburke/joplin-mcp-server/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/jordanburke/joplin-mcp-server/claude-md"><img src="https://agentmods.dev/badge/instructions/jordanburke/joplin-mcp-server/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,061 This file is loaded in full into every session.

When invoked 1,061 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.

Model	Per session	Once invoked
Fable 5.1	$0.01061	$0.01061
Opus 5	$0.00531	$0.00531
Sonnet 5	$0.00212	$0.00212
Haiku 4.5	$0.00106	$0.00106

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

Security

Grade A, and why

joplin-mcp-server 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 10d 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 · 102 lines

How it starts

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

Project Overview

This is a TypeScript MCP (Model Context Protocol) server for Joplin note-taking application. It provides tools to interact with Joplin via its REST API, allowing users to search, read, create, edit, delete, and navigate notes and notebooks.

Key Commands

Build: pnpm build - Compiles TypeScript to dist/ (CommonJS format)
Development: pnpm serve:dev:http - Run in HTTP mode with hot reload
Type checking: pnpm typecheck - Validate TypeScript types
Formatting: pnpm format - Format code with Prettier
Linting: pnpm lint - Run ESLint with auto-fix
Testing: pnpm test - Run all Vitest tests
Validation: pnpm validate - Run format + lint + test + build
CLI Usage: npx joplin-mcp-server --help - Get help

Architecture

Core Components

Main server (src/index.ts): Entry point supporting stdio and HTTP transports
Server Implementations:
- src/server-core.ts: Core MCP server with stdio transport
- src/server-fastmcp.ts: FastMCP HTTP server with health checks and stateless mode
API Client (src/lib/joplin-api-client.ts): HTTP client for Joplin REST API with pagination
Tools (src/lib/tools/): 11 Joplin tools following consistent BaseTool pattern
- list-notebooks, search-notes, read-notebook, read-note, read-multinote
- create-note, create-folder, edit-note, edit-folder, delete-note, delete-folder
CLI (src/bin.ts): CLI entry point for npx execution
Utilities:
- src/lib/parse-args.ts: Command-line argument and environment variable parsing
- src/lib/logger.ts: Configurable logging with file output

Tool Pattern

Each tool follows a consistent pattern:

Extends from BaseTool class (lib/tools/base-tool.ts)
Implements a call() method that takes typed parameters and returns formatted text
Uses the JoplinAPIClient to make API requests
Returns user-friendly formatted text responses
Validates parameters using Zod schemas in the server registration
Includes parameter validation with helpful error messages (e.g., validateId())

Read the full file on GitHub · 102 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.

10d ago First seen · 102 lines · 1,061 tokens per session scan A fb79da563dc8

Subscribe to this mod's changes

joplin-mcp-server CLAUDE.md is an instructions file published in the GitHub repository jordanburke/joplin-mcp-server (7 stars, last pushed 10d ago), licensed MIT. It adds 1,061 tokens to every session, about $0.0053 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.

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

joplin-mcp-server: Instructions file for Claude Code