io.github.Narashiman-K/markdown-notes-mcp

Suprasūtā Markdown Notes — MCP server

Let Claude, VS Code and Antigravity read any document on your machine — without uploading it.

Created by Narashiman Krishnamurthy

Licence: free for personal, non-commercial use. See LICENSE.md.

What it does

AI assistants can read plain text, and some can read PDFs. None of them read EPUB, OpenDocument, PowerPoint or a scanned image, and all of them do it by uploading your file to a server.

This converts documents on your own machine and hands back Markdown that has been tidied for a model to read — tables promoted to real Markdown tables, deep indentation flattened, code properly fenced.

Tools

About tokens

Converting costs you nothing — it all happens locally. But returning a long document into the conversation does cost tokens, at the same rate as pasting it in by hand.

So a long conversion is saved to disk and only a short preview comes back. A 50-page PDF costs roughly 400 tokens instead of 30,000. Short documents are returned in full, since they are cheap either way. Ask for return_content: "full" to override.

Installing

Claude Desktop — the easy way

Download the .mcpb file from Releases and double-click it. Claude Desktop installs it and asks which folders it may read, and optionally for API keys. No Node, no terminal, no JSON.

Claude Desktop — from source

npm install
npm run build
node scripts/install-claude-desktop.mjs --roots "D:\your\documents"

Then restart Claude Desktop completely. The script patches the existing config rather than replacing it, and writes a timestamped backup first.

--roots is optional but recommended: it limits which folders the server will read. Without it, any path the assistant asks for is allowed.

To remove it again: node scripts/install-claude-desktop.mjs --remove

From npm — any MCP host

npm install -g suprasuta-markdown-mcp

Then point your host at the suprasuta-markdown-mcp command, or run it without installing:

{
  "servers": {
    "suprasuta-markdown": {
      "command": "npx",
      "args": ["-y", "suprasuta-markdown-mcp"],
      "env": { "MARKDOWN_MCP_ROOTS": "D:\\your\\documents" }
    }
  }
}

VS Code and Antigravity

Both read a standard MCP configuration — the block above works as-is. Antigravity looks in ~/.gemini/config/mcp_config.json, or .agents/mcp_config.json inside a workspace.

To run a checkout rather than the published package, replace command and args with node and the absolute path to dist/server.js.

Optional cloud features

Both are dormant until a key is present. Everything else works without either.

Keys are read from the environment, never written to disk and never logged.

Settings are read once, at start-up. An MCP server is a long-running process, so a key or folder saved while it is running does not reach it until the host restarts. If a key you have just entered reports as not configured, restart the host before looking for anything more complicated.

Development

npm install          # .npmrc sets include=dev — do not delete it
npm run build        # stages the OCR engine, then bundles with esbuild
npm test             # 19 tests against the built bundle
npm run smoke        # converts every file in samples/ and reports
npm run typecheck

Why the build is esbuild rather than tsc

src/lib/convert/ is kept byte-identical to the copies in the Windows, web and Android apps, so that drift can be detected rather than discovered. Those files use extensionless imports and one Vite-specific ?url import, neither of which Node's own resolver accepts. esbuild resolves both, so the shared files never need Node-shaped edits.

The runtime hook

Three things genuinely differ between a browser and Node, and src/lib/convert/runtime.ts asks the host rather than sniffing for process:

Everything else is shared. src/runtime/node.ts supplies the Node answers and shims exactly one browser global, DOMParser.

A caution learned the hard way: that file used to define document too, and it broke OCR. tesseract.js sniffed for a DOM, found one, took the browser branch and died on window is not defined. Half a browser is worse than none — shim the minimum.

Keeping the copies honest

npm run sync:check              # list differences against all three apps
npm run sync:pull web           # bring the web app's version in
node scripts/sync-converters.mjs --push web

This package is the canonical copy: it is the only one with the runtime hook that lets identical files run in both environments, so fixes start here and flow outward. sync:check reports and exits zero — drift is information, not a build failure.

Privacy Policy

This software collects nothing. No account, no analytics, no telemetry, and no server of its own — document conversion happens entirely on your machine.

Two optional features send data to a third party, and only when you supply your own API key: cloud image recognition sends the image to Google, and audio transcription sends the audio to AssemblyAI. With no keys configured, the software makes no network connections at all. API keys are read from the environment, never written to disk and never logged.

Full policy, covering collection, storage, retention, third-party sharing and contact details: PRIVACY.md.

Related