goodnotes-inkeye-mcp
This server does not currently have a deployable release on Glama. Follow the repository's setup instructions to install and configure it for your MCP client, including any required credentials and local dependencies.
goodnotes-inkeye-mcp
An MCP stdio server for reading a live Goodnotes library. It exposes notebook metadata, page images rendered from the current strokes, exact typed text, and a clearly-labelled OCR/PDF text hint.
It is a thin transport over the gnreader distribution (gnstore, gnlive,
gntext and gnreader). Nothing is uploaded; there are no network calls at
runtime.
How it works
gnstorecopies the live RocksDB (notes_main.db), its WAL and the SQLite projection into a writable snapshot. The Goodnotes container is only read.gnliveloads the page's imported PDF/image background and decodes the live page records withgnreader.Strokes, text and
f1images are drawn inNotesZIndexorder. Highlighters use a per-channel multiply and preserve ink; auto-straightened bars get round caps and compact scribbles are filled solid. Missing image attachments yield animage missingwarning instead of a failed page.FillShapeItemis decoded but not drawn yet; it yields afill shapewarning.The PNG and a JSON sidecar are cached under
$GNREADER_HOMEor$GOODNOTES_INKEYE_HOME; the cache is capped and pruned.
Related MCP server: reMarkable MCP Server
Requirements
macOS with the Goodnotes application installed.
Python 3.10+.
The application that launches the MCP server needs Full Disk Access to read
~/Library/Containers/com.goodnotesapp.x.A writable home for snapshots/cache.
GNREADER_HOMEdefaults to~/.cache/gnreader;GOODNOTES_INKEYE_HOMEis also honored.
Install
From GitHub:
python -m venv ~/.local/share/goodnotes-inkeye/venv
~/.local/share/goodnotes-inkeye/venv/bin/pip install \
"git+https://github.com/oenderg/goodnotes-inkeye-mcp.git"The gnreader dependency is declared as
gnreader @ git+https://github.com/oenderg/gnreader.git. For local
development, install the local checkout first and then install this package
with --no-deps:
python -m venv .venv
. .venv/bin/activate
pip install -e ../gnreader
pip install -e . --no-deps
pip install "mcp>=1.12,<2" pypdfium2 PillowRegister with Claude
claude mcp add goodnotes-inkeye -s user -- \
~/.local/share/goodnotes-inkeye/venv/bin/goodnotes-inkeye-mcpThe console script starts the stdio server. The equivalent JSON is:
{
"mcpServers": {
"goodnotes-inkeye": {
"command": "<venv>/bin/goodnotes-inkeye-mcp",
"args": []
}
}
}Use the real absolute path to the venv on your machine. Do not point the command at a checkout of the source tree unless the checkout is installed.
Tools
Tool | Returns |
| Folder path, UUID, live page count, modified date, |
| Up to 50 notebooks matching all query words against folder/name/UUID. |
| UUID, folder, live/deleted page counts, dates, page ids. |
|
|
| Up to 8 PNG pages from one snapshot. |
| Exact typed-text items from |
| Cheap OCR/PDF text hint; explicitly unreliable. |
| Snapshot age, library counts, package versions, capabilities, cache use. |
Notebook arguments accept a document UUID, exact name, or unique name part. Ambiguous input returns a candidate list instead of guessing. Page numbers are 1-based over live (non-deleted) pages.
Privacy and safety
The Goodnotes container and backup folder are never modified.
Snapshots and render caches are the only writes; they live under the configured home (
~/.cache/gnreaderby default), never inside the package or the container.That directory holds a copy of your Goodnotes database and rendered images of your notebook pages. Treat it like the notebooks themselves, and delete it to wipe the cache.
The server itself makes no network calls. Page images and text it returns are sent to whichever AI client you connect it to, under that client's privacy terms.
OCR is MyScript output and may be wrong, incomplete or stale. Use
get_page_textfor exact typed items andget_page_imageto verify ink.
Known limits
The full list comes from gnreader.capabilities() and is printed by
server_status().
No write support.
Legacy item kinds
f3,f4andf6are unsupported.Nexus/Yjs layout is approximate; math items are attachment/placeholder only.
Shape fill/stroke, sticky notes and elbow/hobby connectors are rendered for the calibrated item set. Sticker colour bodies, pattern tape and type-5 grainy pencil are also drawn; hobby uses a Hobby spline.
The live renderer does not draw fills yet (
fill shapewarning). Livef1images are supported, including rotated images; missing/unreadable attachments warn asimage missing.Whiteboard notebooks have no page canvas and render blank.
Missing built-in/sticker backgrounds render white.
Eraser masks are decoded but not applied.
Highlighter straight bars now have round caps; compact freehand marks use a solid disc union. Freehand ends follow their stored path.
Cache entries are invalidated by package version and installed-renderer code fingerprint.
Updates
Upgrade the package in the server venv, then start a new Claude session so the MCP process restarts and loads the new code. A long-running server keeps the old modules in memory.
License
Licensed under the PolyForm Noncommercial License 1.0.0: you may use, modify and share it for noncommercial purposes. Commercial use needs a separate licence from the author.
Required Notice: Copyright (c) 2026 oenderg (https://github.com/oenderg)
Unaffiliated with Goodnotes Limited. "Goodnotes" is their trademark; it is used here only to describe compatibility.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
This server cannot be deployed
Maintenance
Related MCP Connectors
Read and write the notes and folders of your Grape account, the AI note-taking app.
Turn books in your private library into tables of contents, summaries and study docs.
1Bring your Knacco library into your AI tool: browse, search, read guides and download files.
Personal context for every AI: search, read, and write back to your private Markdown library.
Related MCP Servers
- FlicenseAqualityDmaintenanceEnables AI agents to query and interact with Google NotebookLM notebooks to retrieve citation-backed information. It provides tools for listing notebooks, accessing source data, and asking natural language questions.11-
- AlicenseAqualityDmaintenanceEnables AI assistants to read, search, and traverse your reMarkable tablet's library, including handwritten notes via OCR.12MIT
- AlicenseAqualityDmaintenanceEnables reading and searching handwritten notes from GoodNotes on macOS, providing OCR text, search, and notebook management tools for AI assistants.61MIT
- AlicenseAqualityAmaintenanceEnables AI assistants to read, search, and traverse your entire reMarkable library, including handwritten notes via OCR.14265MIT