reMarkable MCP Server

reMarkable MCP 服务

释放 reMarkable 平板作为 AI 助手第二大脑的全部潜力。此 MCP 服务让 Claude、VS Code Copilot 和其他 AI 工具能够读取、搜索和遍历你的整个 reMarkable 资料库，包括通过 OCR 识别的手写笔记。

为什么选择 rm-mcp？

你的 reMarkable 平板是思考、记笔记和研究的强大工具，但这些知识一直被困在设备中。此 MCP 服务改变了这一切：

• 完整访问资料库 — 浏览文件夹、搜索文档、读取任意文件
• 提取键入文本 — 原生支持 Type Folio 和键入的批注
• 手写 OCR — 将手写笔记转换为可搜索文本
• 支持 PDF 和 EPUB — 从文档中提取文本，以及你的批注
• 智能搜索 — 在整个资料库中查找内容
• 整理资料库 — 重命名、移动和创建文件夹（不会删除任何内容）
• 集成第二大脑 — 搭配 Obsidian、记笔记应用或任何 AI 工作流使用

无论你是在研究、写作还是构思，rm-mcp 都能让你通过 AI 运用 reMarkable 中的所有内容。

---

快速安装

使用 reMarkable Cloud API。需要订阅 reMarkable Connect。

一键设置（推荐）

uvx rm-mcp --setup

这会打开浏览器，提示你输入一次性代码，并输出可直接粘贴到 Claude Code 和 Claude Desktop 的配置。

手动设置

1. 获取一次性代码

前往 my.remarkable.com/device/browser/connect 并生成代码。

2. 转换为令牌

uvx rm-mcp --register YOUR_CODE

3. 添加到 MCP 客户端

Claude Code：

claude mcp add remarkable \
  -e REMARKABLE_TOKEN='<paste token from step 2>' \
  -e REMARKABLE_OCR_BACKEND=sampling \
  -- uvx rm-mcp@latest

Claude Desktop — 添加到 claude_desktop_config.json（使用 uvx 的完整路径，例如通过 which uvx 获取）：

{
  "mcpServers": {
    "remarkable": {
      "command": "/Users/YOU/.local/bin/uvx",
      "args": ["rm-mcp@latest"],
      "env": {
        "REMARKABLE_TOKEN": "<paste token from step 2>"
      }
    }
  }
}

---

---

工具

工具	描述
remarkable_read	读取并提取文档文本（支持分页和搜索）
remarkable_browse	浏览资料库中的文件夹
remarkable_search	搜索多个文档中的内容
remarkable_recent	获取最近修改的文档
remarkable_status	检查连接状态
remarkable_image	获取页面的 PNG/SVG 图像（支持通过采样进行 OCR）

所有工具均为只读，并返回带有后续操作提示的结构化 JSON。

📖 完整工具文档

智能功能

• 多页读取 — 使用 pages="all" 一次读取所有页面，或指定范围，例如 pages="1-3"
• Grep 自动跳转 — grep 会自动查找匹配项并跳转到对应页面
• 自动跳转 — 浏览文档路径时会自动返回其内容
• 自动 OCR — 没有键入文本的笔记本会自动启用 OCR（使用 auto_ocr=False 退出）
• 全文搜索 — 读取文档后会为其建立索引，以便之后快速搜索
• 精简模式 — 使用 compact_output=True 减少响应中的令牌用量
• 批量搜索 — 一次调用即可搜索多个文档
• 视觉支持 — 获取页面图像以提供视觉上下文（图表、模型图、草图）
• 采样 OCR — 使用客户端的 AI 对图像进行 OCR（无需 API 密钥）

使用示例

# Read a document
remarkable_read("Meeting Notes")

# Read all pages at once
remarkable_read("Meeting Notes", pages="all")

# Read a range of pages
remarkable_read("Research Paper", pages="1-3")

# Search for keywords (auto-redirects to matching page)
remarkable_read("Project Plan", grep="deadline")

# Enable OCR for handwritten notes
remarkable_read("Journal", include_ocr=True)

# Browse your library
remarkable_browse("/Work/Projects")

# Search across documents
remarkable_search("meeting", grep="action items")

# Get recent documents with previews
remarkable_recent(limit=5, include_preview=True)

# Get a page image
remarkable_image("UI Mockup", page=1)

# Get image with OCR text extraction
remarkable_image("Handwritten Notes", include_ocr=True)

---

资源

文档会自动注册为 MCP 资源：

URI 方案	描述
remarkable:///{path}.txt	提取的文本内容
remarkableimg:///{path}.page-{N}.png	第 N 页的 PNG 图像（仅笔记本）
remarkablesvg:///{path}.page-{N}.svg	第 N 页的 SVG 矢量图像（仅笔记本）

📖 完整资源文档

---

手写 OCR

rm-mcp 使用采样 OCR——由 MCP 客户端的大模型从手写笔记中提取文本。无需额外的 API 密钥或服务。

工作原理

使用 include_ocr=True 时，rm-mcp 会通过 MCP 采样将页面图像发送给客户端的大模型（Claude、GPT-4 等）。模型会识别手写内容并返回文本。

用法

# OCR on a page image
remarkable_image("Handwritten Notes", include_ocr=True)

# OCR when reading a notebook
remarkable_read("Journal", include_ocr=True)

要求

• 你的 MCP 客户端必须支持 sampling 能力（VS Code + Copilot、Claude Desktop 等）
• REMARKABLE_OCR_BACKEND=sampling（这是默认值）

---

高级配置

根路径过滤

将 MCP 服务限制在 reMarkable 上的特定文件夹中。所有操作都将限定在此文件夹内：

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["rm-mcp"],
      "env": {
        "REMARKABLE_TOKEN": "your-token",
        "REMARKABLE_ROOT_PATH": "/Work"
      }
    }
  }
}

使用此配置：

• remarkable_browse("/") 显示 /Work 的内容
• remarkable_browse("/Projects") 显示 /Work/Projects
• 无法访问 /Work 以外的文档

适用于：

• 在办公时间专注于工作文档
• 分隔个人笔记和工作笔记
• 为特定 AI 工作流限制范围

自定义背景色

设置图像渲染的默认背景色：

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["rm-mcp"],
      "env": {
        "REMARKABLE_TOKEN": "your-token",
        "REMARKABLE_BACKGROUND_COLOR": "#FFFFFF"
      }
    }
  }
}

支持的格式：

• #RRGGBB — RGB 十六进制（例如，白色为 #FFFFFF）
• #RRGGBBAA — RGBA 十六进制（例如，透明色为 #00000000）

默认值为 #FBFBFB（reMarkable 纸张颜色）。此设置会影响 remarkable_image 工具和图像资源。

所有环境变量

变量	默认值	说明
REMARKABLE_TOKEN	（必需）	通过 uvx rm-mcp --setup 获取的身份验证令牌
REMARKABLE_ROOT_PATH	/	将访问限制在特定文件夹内
REMARKABLE_READ_ONLY	（关闭）	设为 1 可禁用重命名、移动和创建文件夹
REMARKABLE_OCR_BACKEND	sampling	OCR 后端（sampling）
REMARKABLE_BACKGROUND_COLOR	#FBFBFB	渲染图像的背景色（#RRGGBB 或 #RRGGBBAA）
REMARKABLE_CACHE_TTL	60	集合缓存 TTL，单位为秒
REMARKABLE_COMPACT	（关闭）	设为 1 或 true 可全局省略响应中的提示
REMARKABLE_MAX_OUTPUT_CHARS	50000	工具响应中的最大字符数
REMARKABLE_PAGE_SIZE	8000	PDF/EPUB 每页的字符数
REMARKABLE_PARALLEL_WORKERS	5	获取元数据时使用的并行工作线程数
REMARKABLE_INDEX_CONTENT	1	设为 0 可禁用 PDF/EPUB 文本的后台索引
REMARKABLE_INDEX_PATH	~/.cache/rm-mcp/index.db	SQLite 全文搜索索引位置
REMARKABLE_INDEX_REBUILD	（关闭）	设为 1 可在启动时强制重建索引

大多数用户只需设置 REMARKABLE_TOKEN。其余变量用于高级调优。

---

使用场景

研究与写作

在 Obsidian 库或类似环境中工作时使用 rm-mcp，将手写笔记中的知识整理到结构化文档中。AI 可以读取你的研究笔记并帮助拓展想法。

每日回顾

让 AI 助手总结近期笔记、查找待办事项，或识别日记条目中的模式。

文档搜索

在整个文档库中搜索（包括手写内容），找到那些只记得一部分内容的笔记。

知识管理

将 reMarkable 当作 AI 可以访问的第二大脑。结合 Obsidian 等工具，你可以构建强大的个人知识系统。

---

文档

指南	说明
工具参考	工具详细文档
资源参考	MCP 资源文档
能力协商	MCP 协议能力
开发	贡献指南和开发环境设置
未来计划	路线图和计划中的功能

---

开发

git clone https://github.com/wavyrai/rm-mcp.git
cd rm-mcp
uv sync --all-extras
uv run pytest test_server.py -v

📖 开发指南

---

许可证

MIT

---

基于 rmscene、PyMuPDF 构建，并从 ddvk/rmapi 汲取灵感。