Skip to main content
Glama
SamMorrowDrums

reMarkable MCP Server

Servidor MCP de reMarkable

Accede a una biblioteca de reMarkable desde clientes MCP como Claude, VS Code Copilot, OpenWebUI y otras herramientas compatibles.

Características

  • Navega por carpetas y documentos recientes.

  • Busca nombres, etiquetas y texto extraído.

  • Lee texto mecanografiado, texto de PDF y EPUB, resaltados y anotaciones.

  • Renderiza cuadernos y PDF anotados como PNG o SVG.

  • Exporta un documento como un recurso PDF completo o Markdown por secciones.

  • Ejecuta OCR de escritura a mano mediante Google Vision o Tesseract.

  • Sube archivos y gestiona carpetas en transportes compatibles.

  • Renderiza Markdown como PDF y súbelo a la tableta.

  • Abre un lienzo interactivo en clientes que admiten MCP Apps.

  • Sirve MCP sobre stdio o Streamable HTTP local.

  • Sirve MCP 2026-07-28 y todas las revisiones anteriores compatibles con el SDK desde un único MCPServer estable del SDK 2.x.


Related MCP server: reMarkable MCP Server

Instalación rápida

Requisito previo: instalar uv

Los comandos siguientes usan uvx, que se incluye con uv. Las imágenes de página se rasterizan con PyMuPDF; no es necesario instalar Cairo, navegador ni ningún runtime gráfico en macOS, Linux o Windows.

macOS y Linux

Usa el instalador independiente oficial:

curl -LsSf https://astral.sh/uv/install.sh | sh

O instala con Homebrew:

brew install uv

Windows

Usa el instalador independiente oficial desde PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

O instala con WinGet:

winget install --id=astral-sh.uv -e

Elige una conexión

Empieza con el primer modo que se ajuste a tu configuración.

Orden

Modo

Configuración

Escrituras

Úsalo cuando

1

USB web

Conecta la tableta y habilita USB web

Subida; destino elegido por la tableta

Quieres la configuración más corta sin suscripción ni modo desarrollador

2

Directorio local

Instala e inicia sesión en la app de escritorio

No

Quieres lecturas sin conexión y sin dispositivo desde la caché de escritorio

3

Nube

Regístrate una vez; se requiere suscripción Connect

Gestión completa de documentos y carpetas

Necesitas acceso inalámbrico o remoto

4

SSH

Habilita el modo desarrollador y configura SSH

Gestión completa y autoría nativa

Necesitas acceso directo al sistema de archivos o escritura de tinta nativa

Interfaz web USB

Conecta por USB y habilita la interfaz web en los Ajustes de almacenamiento de tu tableta.

Instalar modo USB web en VS Code Instalar modo USB web en VS Code Insiders

  1. Conecta tu reMarkable por USB

  2. En tu tableta, abre Ajustes > Almacenamiento y habilita Interfaz web USB

  3. Instala mediante el botón de arriba

Añade a .vscode/mcp.json:

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--usb"],
      "env": {
        "GOOGLE_VISION_API_KEY": "your-api-key"
      }
    }
  }
}
  • Asegúrate de que tu reMarkable esté conectado por USB y desbloqueado

  • Verifica que la interfaz web USB esté habilitada en Ajustes > Almacenamiento

  • La tableta debería ser accesible en http://10.11.99.1


Modo de directorio local

Lee la carpeta de sincronización de la app de escritorio oficial de reMarkable desde el disco. Este modo es sin conexión y de solo lectura. La app de escritorio controla la sincronización.

Añade a .vscode/mcp.json:

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--local-dir"]
    }
  }
}

Sin ruta, la carpeta de datos de la app de escritorio se detecta automáticamente:

  • macOS (app actual): ~/Library/Containers/com.remarkable.desktop/Data/Library/Application Support/remarkable/desktop

  • macOS (app heredada): ~/Library/Application Support/remarkable/desktop

  • Windows: %APPDATA%\remarkable\desktop

  • Linux: ~/.local/share/remarkable/desktop

O apunta a cualquier directorio de estilo xochitl (por ejemplo, una copia de seguridad de la tableta):

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--local-dir", "/path/to/xochitl-data"]
    }
  }
}
  • La frescura del contenido depende de la app de escritorio. Mantenla en ejecución y con sesión iniciada.

  • Este modo es de solo lectura. Las escrituras directas podrían omitir la sincronización y corromper la caché de la app.

  • Si no se puede encontrar el directorio y hay un token de nube configurado, el servidor recurre al modo nube para acceso de lectura (el servidor permanece de solo lectura porque se lanzó en modo de directorio local)


Modo nube

El modo nube funciona sin conexión de dispositivo y requiere una suscripción a reMarkable Connect.

Obtiene metadatos en paralelo y almacena en caché blobs direccionados por contenido en disco. Consulta Rendimiento y caché de nube para la configuración.

1. Obtén un código de un solo uso

Ve a my.remarkable.com/device/desktop/connect y genera un código.

2. Convierte a token

uvx remarkable-mcp --register YOUR_CODE

El registro guarda el token en ~/.rmapi. Cuando tu cliente MCP ejecuta el servidor como el mismo usuario en la misma máquina, remarkable-mcp lee ese archivo automáticamente, por lo que no necesitas poner un token en la configuración del cliente. Establece REMARKABLE_TOKEN solo cuando ~/.rmapi no esté disponible, como cuando el servidor se ejecuta bajo otro usuario o en otra máquina.

3. Configura tu cliente MCP

Definición mínima de servidor independiente del cliente

Añade esta definición de servidor usando la interfaz de configuración MCP o el envoltorio requerido por tu cliente:

{
  "command": "uvx",
  "args": ["remarkable-mcp"]
}

No se necesita una entrada env cuando el servidor puede leer el token desde ~/.rmapi.

VS Code

El .vscode/mcp.json de VS Code usa un objeto servers de nivel superior. La credencial guardada en ~/.rmapi significa que no se requiere entrada de token:

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp"]
    }
  }
}
Claude Desktop y otros clientes

Claude Desktop y muchos otros clientes MCP usan un objeto mcpServers de nivel superior y valores literales en env; no usan el array inputs de VS Code. Con el token disponible en ~/.rmapi, la configuración mínima es:

{
  "mcpServers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp"]
    }
  }
}

Si el archivo de token no está disponible, añade "env": {"REMARKABLE_TOKEN": "tu-token"} a la entrada del servidor remarkable. Consulta la documentación de tu cliente si usa una clave externa diferente o un mecanismo de almacenamiento de secretos.


Modo SSH

SSH proporciona acceso directo al sistema de archivos y autoría nativa de cuadernos. Requiere modo desarrollador, que restablece la tableta de fábrica al habilitarse. Usa este modo solo cuando USB web, directorio local o modo nube no proporcionen la operación que necesitas.

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--ssh"]
    }
  }
}

Consulta la guía de configuración de SSH para autenticación y configuración del dispositivo.



Modos de conexión

Todos los modos admiten lectura, renderizado y exportación de un solo documento. La nube y SSH admiten gestión completa de la biblioteca. USB web admite subida pero no acepta una carpeta de destino. El modo de directorio local es de solo lectura.

Modo

Configuración

Suscripción

Sin conexión

Tableta requerida

Fuente cruda

Subida

Operaciones de carpeta¹

Directorio local

App de escritorio instalada

No²

Sí

No

PDF y EPUB

No

No

USB web

Habilitar en Ajustes

No

Sí

Sí

PDF

Solo raíz

No

Nube

Registro único

Connect

No

No

PDF y EPUB

Sí

Sí

SSH

Modo desarrollador

No

Sí

Sí

PDF y EPUB

Sí

Sí

¹ Operaciones de carpeta = crear carpeta / mover / renombrar / eliminar. La subida y las operaciones de carpeta están habilitadas por defecto; pasa --read-only para exponer un servidor de solo lectura. Las eliminaciones mueven elementos a la papelera y solicitan confirmación cuando tu cliente admite elicitación, y se rechazan sin ella a menos que se establezca REMARKABLE_SKIP_CONFIRM=1.

² La app de escritorio en sí inicia sesión en la nube de reMarkable para sincronizar; el modo de directorio local solo lee lo que la app ya ha sincronizado en disco.

Recurso automático a la nube

Si un transporte de dispositivo seleccionado no está disponible y hay una credencial de nube configurada, el servidor recurre al modo nube. Un servidor lanzado con --local-dir permanece de solo lectura después del recurso. remarkable_status informa el transporte efectivo y establece fell_back_to_cloud.

Pasa --no-cloud-fallback (o establece REMARKABLE_DISABLE_CLOUD_FALLBACK=1) para deshabilitar esto y fallar en su lugar cuando el dispositivo no esté accesible.

El transporte se resuelve una vez por proceso de servidor. Reinicia el servidor MCP después de conectar un dispositivo o iniciar la app de escritorio si el proceso ya recurrió a la nube.

Configuración detallada:


OpenWebUI (Streamable HTTP)

La conexión MCP nativa de OpenWebUI usa Streamable HTTP. Inicia remarkable-mcp en la misma máquina:

uvx remarkable-mcp --http

Luego añade http://127.0.0.1:8000/mcp como URL del servidor MCP en OpenWebUI. El transporte HTTP se combina con --usb, --ssh y --read-only; por ejemplo:

uvx remarkable-mcp --usb --http

La dirección de enlace y el puerto también se pueden establecer con --host / --port o REMARKABLE_MCP_HOST / REMARKABLE_MCP_PORT.

El servidor usa el endpoint de doble era del SDK de Python MCP 2.x. Las solicitudes modernas 2026-07-28 no tienen sesión; los clientes más antiguos continúan usando el protocolo de inicio y las sesiones MCP heredadas en la misma ruta /mcp. El token de reMarkable y el transporte de tableta seleccionado permanecen como configuración local de CLI/env del proceso y nunca se infieren de los encabezados de autorización HTTP de MCP.

[!ADVERTENCIA] Streamable HTTP no tiene autenticación incorporada. Se enlaza a 127.0.0.1 por defecto. Mantén ese valor predeterminado a menos que controles el límite de red. Los enlaces comodín como 0.0.0.0 y :: se rechazan porque no pueden proporcionar una lista de hosts estricta. Una dirección concreta no loopback está permitida pero expone cada herramienta habilitada, incluidas las escrituras, a clientes que puedan alcanzar el puerto.

Acceso remoto a través de un proxy inverso autenticado

Mantén remarkable-mcp en su enlace de bucle local predeterminado y coloca el proxy en el mismo host. La protección contra reencuadre de DNS de MCPServer solo permite valores de Host y Origin de bucle local de forma predeterminada. Un proxy que reenvíe su nombre de host público sin cambios recibirá por tanto 421 Solicitud mal dirigida; un Origin de navegador público recibirá 403 Prohibido.

El proxy debe autenticar las solicitudes, reescribir Host al upstream de bucle local y limpiar Origin. Por ejemplo, con nginx y un archivo htpasswd existente:

location /mcp {
    auth_basic "reMarkable MCP";
    auth_basic_user_file /etc/nginx/remarkable-mcp.htpasswd;

    proxy_pass http://127.0.0.1:8000;
    proxy_http_version 1.1;
    proxy_buffering off;
    proxy_read_timeout 3600s;

    # Required by MCPServer's default DNS-rebinding protection.
    proxy_set_header Host 127.0.0.1:8000;
    proxy_set_header Origin "";
}

No expongas el puerto upstream directamente. Configura OpenWebUI con la URL del proxy autenticado, como https://mcp.example.com/mcp.

Para NixOS, remarkable-mcp-bridge.nix proporciona un módulo systemd con el mismo valor predeterminado de bucle local:

{
  imports = [ ./remarkable-mcp-bridge.nix ];
  services.remarkable-mcp = {
    enable = true;
    command = "/opt/remarkable-mcp/.venv/bin/remarkable-mcp";
  };
}

El usuario del servicio debe tener sus credenciales de reMarkable en /var/lib/remarkable-mcp (o en el home configurado). El módulo añade Tesseract a la ruta de búsqueda de ejecutables del servicio; instala el command configurado por separado.


Integración con OpenClaw

remarkable-mcp funciona como una habilidad de OpenClaw. Añádelo a tu openclaw.json:

{
  "mcpServers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--usb"]
    }
  }
}

Instálalo desde ClawHub:

clawhub install remarkable-mcp

O copia el SKILL.md de este repositorio a tu directorio ~/.openclaw/skills/remarkable-mcp/.


Herramientas

Herramienta

Descripción

remarkable_read

Lee y extrae texto de documentos (con paginación y búsqueda)

remarkable_browse

Navega carpetas, busca por nombre de documento o filtra por etiquetas

remarkable_search

Busca contenido en varios documentos (con filtrado por etiquetas)

remarkable_recent

Obtiene documentos modificados recientemente

remarkable_status

Comprueba el estado de la conexión y la matriz de capacidades por transporte

remarkable_image

Obtiene imágenes PNG/SVG de páginas con OCR opcional

remarkable_export

Exporta un documento como PDF o Markdown temporal

Las herramientas de lectura/búsqueda/renderizado son de solo lectura. remarkable_export nunca cambia la tableta, pero escribe un archivo temporal acotado en el host del servidor MCP y por tanto declara readOnlyHint=false. Los enlaces de exportación caducan a los 15 minutos y el servidor conserva como máximo ocho a la vez. Los transportes compatibles también registran herramientas de escritura de forma predeterminada; pasa --read-only para desactivarlas. Consulta Herramientas de escritura. Los clientes que admiten Aplicaciones MCP también pueden abrir remarkable_canvas.

Referencia completa de herramientas

Comportamiento de las herramientas

  • Navegar por una ruta de documento devuelve su contenido.

  • El texto vacío de un cuaderno puede activar OCR automáticamente.

  • La búsqueda puede examinar varios documentos coincidentes.

  • Las herramientas de imagen devuelven contenido visual que la extracción de texto no capta.

  • remarkable_read.total_pages es el recuento físico de documentos; content_pages cuenta los fragmentos de texto extraídos, y more / next_page continúan esos fragmentos. Las lecturas de PDF sin procesar cuentan las páginas del PDF ya descargado. Si un archivo EPUB sin procesar no puede leerse, su texto se devuelve igualmente con total_pages: null y total_pages_known: false.

  • Las imágenes PNG de páginas con respaldo PDF fusionan la página de origen y las anotaciones automáticamente; pasa render_merged=False para obtener solo la capa de anotaciones.

  • Las exportaciones PDF conservan el orden físico de las páginas y fusionan las capas subyacentes mapeadas con las anotaciones de forma predeterminada. Las exportaciones Markdown mantienen las secciones fijas de origen/escritura/anotación/OCR sin adivinar la estructura del documento.

  • El OCR usa Google Vision cuando está configurado y, de lo contrario, se ejecuta localmente con Tesseract.

  • Navegar y buscar aceptan filtros de etiquetas.

Ejemplo de uso

# Read a document
remarkable_read("Meeting Notes")

# Search for keywords
remarkable_read("Project Plan", grep="deadline")

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

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

# Filter by tags
remarkable_browse("/", tags=["important"])
remarkable_browse("/Work", tags=["project", "active"])

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

# Search with tag filter
remarkable_search("project", tags=["work"])

# Get recent documents
remarkable_recent(limit=10)

# Get a page image (for visual content like UI mockups or diagrams)
remarkable_image("UI Mockup", page=1)

# Get SVG for editing in design tools
remarkable_image("Wireframe", output_format="svg")

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

# Imported PDF pages include their reMarkable annotations automatically
remarkable_image("Research Paper", page=3)

# Request only the reMarkable annotation layer
remarkable_image("Research Paper", page=3, render_merged=False)

# Transparent background for compositing
remarkable_image("Logo Sketch", background="#00000000")

# Compatibility mode: return resource URI instead of embedded resource
remarkable_image("Diagram", compatibility=True)

# Export a complete PDF through a temporary MCP ResourceLink
remarkable_export("Meeting Notes")

# Export honest, sectioned Markdown with opt-in OCR
remarkable_export("Journal", output_format="markdown", include_ocr=True)

# Export only full-page annotation layers when archive data is available
remarkable_export("Research Paper", pdf_mode="annotations")

Nota: El renderizado PNG usa PyMuPDF tanto para los SVG de cuadernos como para los PDF, por lo que remarkable_image no requiere Cairo, Inkscape, Chromium ni ningún otro runtime gráfico del sistema. Si el análisis de trazos local no puede procesar una página, los modos USB y SSH recurren a la exportación PDF nativa de la tableta y el modo nube recurre al PDF de origen original cuando existe.


Recursos

Los documentos se registran automáticamente como recursos MCP:

Esquema URI

Descripción

remarkable:///{ruta}.txt

Contenido de texto extraído

remarkableraw:///{ruta}.pdf.txt

Texto extraído del PDF original

remarkableraw:///{ruta}.epub.txt

Texto extraído del EPUB original

remarkableimg:///{ruta}.página-{N}.png

Imagen PNG de la página N (solo cuadernos)

remarkablesvg:///{ruta}.página-{N}.svg

Imagen SVG vectorial de la página N (solo cuadernos)

remarkableexport:///{formato}/{id}

Exportación temporal de PDF o Markdown

Los documentos en la papelera se excluyen de la búsqueda por herramienta, lienzo y recurso, de modo que un elemento en la papelera no puede hacer sombra a un documento activo con el mismo nombre.

remarkable_export devuelve un ResourceLink en lugar de incrustar contenido de archivo potencialmente grande en la respuesta de la herramienta. El servidor almacena el archivo en un directorio temporal privado durante 15 minutos, conserva como máximo ocho exportaciones y elimina las exportaciones gestionadas al apagarse. Obtén y guarda el recurso enlazado para un uso duradero.

Referencia completa de recursos


OCR

Para contenido manuscrito, remarkable-mcp ofrece dos motores de OCR:

Motor

Configuración

Sin conexión

Notas

Google Vision

Clave de API

No

Buen soporte de escritura a mano

Tesseract

Instalación del sistema

Sí

Más adecuado para texto impreso

Configuración rápida

Establece REMARKABLE_OCR_BACKEND en tu configuración de MCP:

{
  "env": {
    "REMARKABLE_OCR_BACKEND": "auto"
  }
}

Opciones: auto, google, tesseract

  1. Habilita la API de Cloud Vision

  2. Crea una clave de API

  3. Añádela a la configuración: "GOOGLE_VISION_API_KEY": "tu-clave"

Coste: 1.000 solicitudes gratuitas al mes, luego ~1,50 $ por cada 1.000.

Guía de configuración de Google Vision

OCR de código abierto diseñado para texto impreso. Resultados deficientes con escritura a mano, pero útil como alternativa sin conexión.

# Install Tesseract
# macOS
brew install tesseract

# Ubuntu/Debian
sudo apt install tesseract-ocr

# Windows
choco install tesseract

Comportamiento predeterminado (auto)

Cuando REMARKABLE_OCR_BACKEND=auto (predeterminado):

  1. Google Vision (si GOOGLE_VISION_API_KEY está definida)

  2. Tesseract (alternativa)


Herramientas de escritura por transporte

Las herramientas de escritura permiten subir, organizar y gestionar documentos en tu reMarkable. Habilitadas de forma predeterminada en los transportes con capacidad de escritura. Los modos nube y SSH admiten el conjunto completo; el modo USB web solo admite la subida (su firmware no expone operaciones de carpetas); el modo de directorio local es siempre de solo lectura. Pasa --read-only para exponer un servidor de solo lectura en otro lugar.

Característica

Directorio local

Modo nube

Modo SSH

Modo USB web

Subir

❌

✅

✅

✅ (carpeta seleccionada de la tableta)

Crear carpeta

❌

✅

✅

❌

Mover

❌

✅

✅

❌

Renombrar

❌

✅

✅

❌

Eliminar

❌

✅ (→ papelera)

✅ (→ papelera; opcional permanente)

❌

Desactivación de las herramientas de escritura (modo de solo lectura)

Las herramientas de escritura están activadas de forma predeterminada en cada modo con capacidad de escritura. El modo de directorio local es siempre de solo lectura. Para hacer que otro transporte sea de solo lectura, añade la marca --read-only:

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--read-only"]
    }
  }
}

Se combina con cualquier marca de transporte (--ssh, --usb):

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--ssh", "--read-only"]
    }
  }
}

O establece la variable de entorno:

{
  "env": {
    "REMARKABLE_READ_ONLY": "1"
  }
}

La marca heredada --write y la variable REMARKABLE_ENABLE_WRITE todavía se aceptan por compatibilidad hacia atrás, pero ahora son operaciones nulas (la escritura es el valor predeterminado). --write y --read-only son mutuamente excluyentes.

Herramientas de escritura disponibles

Herramienta

Descripción

remarkable_upload(ruta_archivo, carpeta_padre, nombre_documento, diferir_reinicio)

Sube un archivo PDF o EPUB (nube, SSH y USB web; USB web conserva el nombre pero ignora carpeta_padre)

remarkable_markdown_to_pdf(markdown, nombre_documento, carpeta_padre, diferir_reinicio)

Renderiza Markdown como PDF paginado y lo sube (nube, SSH y USB web)

remarkable_mkdir(nombre_carpeta, padre, diferir_reinicio)

Crea una nueva carpeta (nube y SSH)

remarkable_move(documento, carpeta_destino, diferir_reinicio)

Mueve un documento o carpeta (nube y SSH)

remarkable_rename(documento, nuevo_nombre, diferir_reinicio)

Renombra un documento o carpeta (nube y SSH)

remarkable_delete(documento, diferir_reinicio, permanente)

Mueve un documento/carpeta a la papelera; SSH puede eliminarlo permanentemente con permanente=True

remarkable_refresh()

Reinicia xochitl de forma segura una vez para aplicar escrituras pendientes realizadas con diferir_reinicio=True; no hace nada después de que este proceso haya confirmado un estado limpio — solo SSH

remarkable_author(método, ..., diferir_reinicio)

Autoriza tinta y cuadernos nativos — draw (añadir trazos), add_page (añadir una página en blanco al cuaderno), create_document (nuevo cuaderno) — solo SSH

Seguridad

  • Subida de registros en modo nube, SSH y USB web — el modo de directorio local nunca expone herramientas de escritura.

  • mkdir, move, rename, delete se registran solo en modos nube y SSH — no se exponen en USB web (el firmware USB web de la tableta no tiene endpoints de carpeta/mover/renombrar/eliminar), manteniendo la lista de herramientas limitada a lo que el transporte activo realmente soporta.

  • Delete solicita confirmación cuando es posible — si el cliente admite la elicitación MCP, remarkable_delete pide al usuario que confirme antes de eliminar. El MCP SDK 2.x transporta esa solicitud como una petición de entrada de varias rondas para clientes 2026-07-28 y como elicitación push para clientes heredados. Si el cliente no puede mostrar una solicitud, el borrado se rechaza (no se realiza) a menos que REMARKABLE_SKIP_CONFIRM=1 esté definido — de modo que la escritura activada por defecto no puede eliminar silenciosamente desde clientes que carecen de elicitación. La nube y SSH mueven los elementos a la Papelera por defecto. SSH también admite permanent=True para una eliminación permanente solicitada explícitamente; la eliminación permanente en la nube sigue siendo una operación de gestión de la Papelera en la app/tableta. Define REMARKABLE_SKIP_CONFIRM=1 para permitir borrados sin solicitud en entornos automatizados. Todas las herramientas de escritura llevan ToolAnnotations(read_only_hint=False) (y destructive_hint=True para delete) para que un harness de agente pueda controlar las escrituras en la capa MCP.

  • El trabajo SSH es justo y serializado por servidor — un despachador FIFO es dueño de cada subproceso SSH, de modo que los escaneos de inicio, lecturas, subidas, mutaciones y sondeos de refresco no pueden saturar la conexión USB CDC de la tableta de forma concurrente. Las lecturas de metadatos en caché omiten la cola.

  • Las escrituras SSH concurrentes comparten una barrera de refresco — las escrituras casi simultáneas se persisten en orden FIFO, y luego cada llamada participante espera un reinicio compartido de xochitl antes de informar éxito. Un debounce acotado fusiona ráfagas sin éxito en segundo plano ni tardío.

  • Los refrescos SSH evitan la ruta de reinicio de emergencia del firmware — el refresco serializado limpia solo el contador de inicio de systemd de xochitl inmediatamente antes del reinicio, y luego requiere sesiones SSH estables y no multiplexadas en el mismo arranque. Los alias de OpenSSH se resuelven con ssh -G; si USB web era accesible en ese host efectivo antes del reinicio, el puerto 80 también debe recuperarse. Un sondeo fallido mantiene refresh_pending: true y nunca reproduce la escritura.

  • Los reintentos son deliberadamente limitados — solo los fallos de conexión que demuestran que el comando remoto nunca se inició (por ejemplo, conexión rechazada, tiempo de conexión agotado o tiempo de banner agotado) reciben retroceso exponencial acotado. Los fallos de escritura ambiguos o posteriores al inicio nunca se reproducen; el error dirige al llamante a refrescar e inspeccionar la tableta en su lugar.

  • Para operaciones masivas explícitas, pasa defer_restart=True a cada escritura (incluida remarkable_author) — o define REMARKABLE_DEFER_RESTART=1 — y llama a remarkable_refresh() una vez al final. Las escrituras diferidas regresan inmediatamente con refresh_pending: true; un refresco adicional es un no-op solo después de que el proceso del servidor actual haya confirmado un estado limpio. Un proceso nuevo realiza un refresco de recuperación conservador porque no puede saber si un proceso anterior dejó cambios de disco pendientes.

  • Una escritura SSH de varios pasos que falla después de cualquier mutación confirmada devuelve write_partially_persisted, indica no repetir e informa si la recuperación de refresco sigue pendiente. Un fallo de refresco compartido se propaga solo a los participantes cuya propia mutación estaba sucia; los fallos limpios de validación/pre-ejecución conservan su error original.

  • Las solicitudes HTTP USB usan el mismo núcleo de operación acotado con REMARKABLE_USB_MAX_CONCURRENCY (por defecto 2). La sincronización en la nube mantiene su capa de solicitudes existente, agrupada y consciente de idempotencia, y el control REMARKABLE_SYNC_WORKERS.

Ejemplos

# Upload a PDF
remarkable_upload("paper.pdf", parent_folder="/Research")

# Render Markdown and upload the PDF without creating a local file
remarkable_markdown_to_pdf(
    "# Meeting Notes\n\n- Follow up with Sam",
    document_name="Meeting Notes",
    parent_folder="/Research",
)

# Create a folder
remarkable_mkdir("2024 Archive", parent="/Archive")

# Move a document
remarkable_move("Meeting Notes", "/Archive/2024 Archive")

# Rename a document
remarkable_rename("Untitled", "Q4 Planning Notes")

# Delete (destructive; confirms via elicitation when supported)
remarkable_delete("Old Draft")

# Permanently delete in SSH mode only
remarkable_delete("Disposable Test", permanent=True)

# Bulk import (SSH): defer the restart on each write, then refresh once.
# One xochitl restart for the whole batch instead of one per upload.
remarkable_upload("a.pdf", parent_folder="/Research", defer_restart=True)
remarkable_upload("b.pdf", parent_folder="/Research", defer_restart=True)
remarkable_refresh()

# Author native ink and notebooks (SSH only)
# Append pen/highlighter strokes to a page (coordinates normalized [0,1] from
# the page's top-left). The interactive canvas Save button calls this too.
remarkable_author(
    method="draw", document="Ideas", page=1,
    strokes=[{"points": [[0.1, 0.2], [0.8, 0.2]], "tool": "highlighter", "color": "yellow"}],
)

# Append a blank, drawable page to the end of a notebook
remarkable_author(method="add_page", document="Ideas")

# Create a new blank notebook
remarkable_author(method="create_document", name="Sketches")

# Only seed typed text when the user explicitly requested it.
remarkable_author(method="create_document", name="Meeting notes", text="Agenda\nFollow-ups")

Aplicación de lienzo interactivo (MCP Apps)

Un visor de páginas interactivo construido sobre la extensión MCP Apps (SEP-1865). Los clientes que admiten MCP Apps (como ChatGPT, Claude, VS Code y MCP Inspector) renderizan un lienzo en un panel lateral donde puedes ver una página de documento y navegar por ella.

No hay ninguna bandera para activarlo — la herramienta remarkable_canvas y su recurso ui://remarkable/canvas están siempre registrados, y la capacidad se negocia automáticamente en las capacidades del cliente (descubrimiento moderno o un handshake initialize heredado). Los clientes con capacidad de app abren el lienzo interactivo; cualquier otro cliente simplemente recibe la página renderizada como imagen, por lo que la herramienta es segura y útil en todas partes.

Esto registra una herramienta:

Tool

Description

remarkable_canvas(document, page)

Abrir una página en el visor de lienzo interactivo

Cómo se comporta:

  • Clientes con capacidad de app abren el lienzo (declarado en ui://remarkable/canvas, MIME text/html;profile=mcp-app) y pueden pasar páginas del documento a través del puente postMessage de MCP Apps — el servidor entrega cada página renderizada en el structuredContent del resultado del wire (structured_content en Python).

  • Otros clientes siguen recibiendo la página renderizada como una imagen PNG incrustada, por lo que la herramienta es útil en todas partes; simplemente no abrirá el panel interactivo. Los metadatos _meta.ui / ui:// son inertes para los clientes que no anuncian la extensión de UI de MCP Apps.

Dibujo y creación desde el lienzo

Cuando el modo de escritura está activado (el predeterminado) y el transporte activo es SSH, el lienzo se convierte en una superficie de escritura:

  • Dibujar: elige un lápiz o rotulador, dibuja y luego guarda la tinta nativa .rm en el dispositivo.

  • Añadir página: pon en cola una página de cuaderno nativa en blanco, dibuja en ella y luego guarda.

  • Una única fuente de verdad: el lienzo llama a la misma herramienta remarkable_author que llamaría un modelo (method="draw" al guardar, method="add_page" para +Page), de modo que la ruta humana y la ruta del modelo producen resultados byte-idénticos.

Los controles Guardar / Dibujar / +Page están ocultos cuando la página no es escribible (modo de solo lectura o un transporte que no sea SSH), y el lienzo vuelve a un visor de imágenes simple. El puente iframe sigue la especificación de MCP Apps, pero es mejor validarlo contra tu cliente específico.


Configuración avanzada

Filtrado de ruta raíz

Limita el servidor MCP a una carpeta específica en tu reMarkable. Todas las operaciones se limitarán a esta carpeta:

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--ssh"],
      "env": {
        "REMARKABLE_ROOT_PATH": "/Work",
        "GOOGLE_VISION_API_KEY": "your-api-key"
      }
    }
  }
}

Con esta configuración:

  • remarkable_browse("/") muestra el contenido de /Work

  • remarkable_browse("/Projects") muestra /Work/Projects

  • Los documentos fuera de /Work no son accesibles

Útil para:

  • Centrarse en documentos de trabajo durante el horario de oficina

  • Separar notas personales y profesionales

  • Limitar el alcance para flujos de trabajo de IA específicos

Color de fondo personalizado

Define el color de fondo predeterminado para el renderizado de imágenes:

{
  "servers": {
    "remarkable": {
      "command": "uvx",
      "args": ["remarkable-mcp", "--ssh"],
      "env": {
        "REMARKABLE_BACKGROUND_COLOR": "#FFFFFF"
      }
    }
  }
}

Formatos admitidos:

  • #RRGGBB: hex RGB, como #FFFFFF

  • #RRGGBBAA: hex RGBA, como #00000000

El valor predeterminado es #FBFBFB (color de papel reMarkable). Esto afecta tanto a la herramienta remarkable_image como a los recursos de imagen.


Configuración de reintentos

Las solicitudes a la API en la nube se reintentan automáticamente ante fallos transitorios (HTTP 429, 500, 502, 503, 504) y errores de red con retroceso exponencial y jitter. Puedes ajustar esto mediante variables de entorno:

Variable

Default

Description

REMARKABLE_RETRY_ATTEMPTS

3

Número máximo de intentos de solicitud (mínimo 1)

REMARKABLE_RETRY_DELAY

2.0

Retardo base en segundos para el retroceso exponencial

Los reintentos por límite de tasa respetan los valores Retry-After numéricos y en fecha HTTP, con un tope de 20 segundos. Los fallos de autenticación activan la renovación del token en lugar de reintentar.


Rendimiento y caché en la nube

El modo nube está diseñado para hacer rápido un flujo de trabajo sin dispositivo:

  • Recorrido en paralelo: obtener metadatos de documentos de forma concurrente.

  • Agrupación de conexiones: reutilizar conexiones HTTP.

  • Caché de blobs direccionada por contenido: reutilizar blobs inmutables por hash y obtener nuevos hashes cuando los documentos cambian.

Normalmente no necesitas configurar nada de esto, pero estas variables de entorno te permiten ajustarlo:

Variable

Default

Description

REMARKABLE_SYNC_WORKERS

16

Trabajadores paralelos para las descargas en la nube (limitado a 64).

REMARKABLE_DISABLE_CACHE

sin definir

Definir a 1 para deshabilitar por completo la caché de blobs en disco.

REMARKABLE_CACHE_DIR

~/.remarkable/cache/blobs

Dónde se almacenan los blobs en caché.

REMARKABLE_CACHE_MAX_BLOB

4194304 (4 MiB)

Los blobs más grandes que esto se transmiten pero no se almacenan en caché.

La caché es puramente un acelerador local: eliminar REMARKABLE_CACHE_DIR solo obliga a la siguiente lectura a volver a descargar. El hash raíz mutable de la nube siempre se obtiene fresco, por lo que nunca ves una biblioteca obsoleta.


Flujos de trabajo comunes

  • Leer notas recientes y extraer elementos de acción.

  • Buscar nombres, etiquetas, texto escrito y salida de OCR.

  • Revisar PDFs anotados con la página de origen y las anotaciones juntas.

  • Mover notas seleccionadas a otro flujo de trabajo local.

  • Subir PDFs de referencia o documentos Markdown generados.


Documentación

Guide

Description

SSH Setup

Habilitar el modo desarrollador y configurar SSH

Google Vision Setup

Configurar OCR de escritura a mano

Tools Reference

Documentación detallada de herramientas

Resources Reference

Documentación de recursos MCP

Capability Negotiation

Capacidades del protocolo MCP

Development

Configuración de contribución y desarrollo

Future Plans

Hoja de ruta y funciones planificadas


Desarrollo

git clone https://github.com/SamMorrowDrums/remarkable-mcp.git
cd remarkable-mcp
uv sync --all-extras
uv run pytest -v

Guía de desarrollo

Prueba de humo multi-transporte

Cuando algo parece roto, ejecuta primero la prueba de humo determinista y sin IA. Esta prueba maneja el servidor real a través de MCP y ejercita todas las herramientas disponibles en cada transporte alcanzable en este orden: directorio local, nube, USB web y luego SSH.

uv run python smoke/run_smoke.py            # all available modes
uv run python smoke/run_smoke.py --read-only # connectivity + reads only

Guía de prueba de humo y expectativas por modo.


Licencia

MIT


Construido con rmscene, PyMuPDF, markdown-it-py e inspiración de ddvk/rmapi.

Available Tools

14 tools
remarkable_browseA
Read-onlyIdempotent

Browse your reMarkable library or search for documents. Three modes:

  1. Browse mode (default): List contents of a folder

    • Use path="/" for root folder

    • Use path="/FolderName" to navigate into folders

  2. Search mode: Find documents by name

    • Set query="search term" to search across all documents

  3. Filter by tags: Find documents with specific tags

    • Set tags=["tag1", "tag2"] to filter by tags

    • Works in both browse and search modes

Results include document names, types, modification dates, and tags.

Note: If REMARKABLE_ROOT_PATH is configured, only documents within that folder are accessible. Paths are relative to the root path.

  • path: Folder path to browse (default: "/" for root)

  • query: Search term to find documents by name (optional, triggers search mode)

  • tags: List of tags to filter documents (optional, case-insensitive)

ParametersJSON Schema
NameRequiredDescriptionDefault
pathNo/
tagsNo
queryNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description adds significant behavioral context beyond annotations: the three modes, results included (names, types, dates, tags), and the note about REMARKABLE_ROOT_PATH restricting access. No contradictions with annotations (readOnlyHint, idempotentHint, destructiveHint).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with sections (usecase, instructions, parameters, examples), each sentence adds value, and it is front-loaded with the core use case. No unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 3 optional parameters, an output schema, and annotations covering read-only behavior, the description is complete. It covers all modes, path restrictions, and examples. No missing information that would hinder tool selection or invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by explaining each parameter's purpose (path for folder, query for search, tags for filtering), their defaults, and how they interact. Examples illustrate usage clearly.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the tool's purpose: 'Browse your reMarkable library or search for documents.' It details three modes (browse, search, filter by tags) and provides clear examples, effectively distinguishing it from sibling tools like remarkable_search.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit instructions for when to use each mode (browse, search, filter), includes a note about the REMARKABLE_ROOT_PATH configuration, and gives examples. However, it does not explicitly differentiate from the sibling tool remarkable_search, which might lead to confusion about which search tool to use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_canvasA
Read-only

Open a reMarkable page in an interactive canvas viewer. Renders a notebook or document page and, in clients that support MCP Apps interactive UI, opens a canvas viewer that lets the user page through the document. This is the entry point for the interactive viewer.

The canvas is currently a read-only viewer (render + page navigation). For plain image extraction without the interactive surface, use remarkable_image instead.

Clients that do not support MCP Apps still get the rendered page back as an embedded PNG image, so this tool is useful everywhere; it just won't open the interactive panel.

  • document: Document name or path (use remarkable_browse to find documents)

  • page: Page number to open (default: 1, 1-indexed)

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNo
documentYes

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate readOnlyHint=true and openWorldHint=false. The description adds that the canvas is read-only with page navigation and explains different behavior for clients with/without MCP Apps support, plus return of embedded PNG for non-interactive clients. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear <usecase>, <instructions>, <parameters>, and <examples> sections. Every sentence adds value without unnecessary verbosity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers the tool's purpose, usage, parameter details, behavioral differences, and includes examples. It is complete for a read-only tool with interactive capabilities, though error handling or conditional behavior when document is not found is not mentioned.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, but the description adds meaning for both parameters: document can be name or path (with hint to use remarkable_browse), page is 1-indexed with default 1, and examples are provided. This compensates well for the schema's lack of descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states 'Open a reMarkable page in an interactive canvas viewer' and distinguishes from sibling remarkable_image for plain image extraction, giving a specific verb and resource with clear differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides clear context for when to use this tool (interactive viewing) vs alternatives (use remarkable_image for plain extraction) and advises using remarkable_browse to find documents. It does not explicitly list exclusions but implies the alternative use case.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_deleteA
Destructive

Delete a document or folder on the reMarkable tablet. DESTRUCTIVE operation. By default the item is moved to the tablet's Trash and remains recoverable. In SSH mode only, permanent=True removes the resolved UUID and all sidecar files instead; use that only when the user explicitly asked for permanent deletion.

Works in cloud and SSH modes (default; --read-only disables). Not available over the USB web interface.

If the client supports elicitation, this tool asks the user to confirm before deleting. If the client cannot show a confirmation prompt, the delete is refused unless REMARKABLE_SKIP_CONFIRM=1 is set (for headless automation).

  • document: Name or path of the document/folder to delete

  • defer_restart: SSH only. Skip the xochitl restart so a batch of deletes can refresh once via remarkable_refresh() instead of once per delete. Sets "refresh_pending": true. Ignored in cloud mode.

  • permanent: SSH only. Permanently remove the resolved document/folder files instead of moving the item to Trash (default: False).

ParametersJSON Schema
NameRequiredDescriptionDefault
documentYes
permanentNo
defer_restartNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark destructiveHint=true, and the description reinforces this while adding substantial detail: items are moved to Trash by default, permanent=True removes the resolved UUID and sidecar files, confirmation is required unless skipped, and defer_restart triggers a refresh_pending flag. This significantly enriches the behavioral model beyond the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with usecase, instructions, parameters, and examples. Each section is dense with useful information without redundancy. The front-loaded usecase immediately states the purpose, and the instructions convey critical safety and mode details efficiently.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers all key aspects: default Trash behavior vs permanent deletion, mode availability (cloud/SSH, not USB), confirmation mechanics, parameter nuances, and example invocations. Even though an output schema exists, the description sufficiently contextualizes the operation for a destructive tool with mode-specific behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While the schema only lists titles and types, the description's <parameters> section explains each parameter in practical terms: 'document' is a name/path, 'permanent' is SSH-only and removes files permanently, and 'defer_restart' is SSH-only and skips restart to batch deletes. This fully compensates for the 0% schema description coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear statement: 'Delete a document or folder on the reMarkable tablet.' This specifies the verb (delete), the resource (document or folder), and the scope (reMarkable tablet), effectively distinguishing it from sibling tools like remarkable_move or remarkable_rename.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage context: it works in cloud and SSH modes (not USB web interface), is destructive by default, and explains when permanent deletion should be used ('only when the user explicitly asked for permanent deletion'). It also covers confirmation behavior and the defer_restart option, giving clear guidance on when and how to invoke the tool safely.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_exportA

Export one reMarkable document as a reusable PDF or Markdown file. Exports a single document without modifying the tablet or its library.

The generated file is written to a server-managed temporary directory and returned as an MCP ResourceLink. The tool response stays small: it never embeds the PDF/Markdown as base64 and never writes to an arbitrary host path. The resource expires after 15 minutes and may be evicted earlier when more than eight exports are retained. Fetch and save the linked resource for durable use.

PDF behavior:

  • pdf_mode="merged" (default) preserves complete physical pages, combining mapped PDF underlays and reMarkable annotations.

  • pdf_mode="annotations" exports full-page annotation layers only when the transport provides a document archive.

  • Pages remain in physical device order. A render failure produces a labeled placeholder at that ordinal and a partial-export warning; pages are not skipped.

Markdown behavior:

  • Preserves basic source metadata and fixed source text, typed text, annotation, highlight, and OCR sections.

  • OCR is opt-in and uses the same configured/cached OCR path as remarkable_read.

  • Extracted text is kept verbatim; the exporter does not invent headings, lists, links, or page attribution it cannot prove.

ParametersJSON Schema
NameRequiredDescriptionDefault
documentYes
pdf_modeNomerged
include_ocrNo
output_formatNopdf

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description goes well beyond annotations by detailing that the output is written to a temporary directory, returned as a MCP ResourceLink (never base64 or arbitrary path), expires after 15 minutes, and may be evicted if more than eight exports are retained. It also explains PDF modes, Markdown behavior, OCR opt-in, and partial export handling. No contradiction with annotations (destructiveHint=false is consistent with 'without modifying the tablet').

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description uses a clear XML-like structure (usecase, instructions, parameters, examples) that is easy to parse. It front-loads the essential purpose and then goes into necessary detail. While verbose, every section adds value; minor trimming could improve conciseness without losing information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 4 parameters (1 required), no output schema, and moderate complexity, the description covers input requirements, behavioral details (resource lifespan, eviction policy), error handling (render failure placeholders), and usage examples. It leaves no significant gaps for an AI agent to infer.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description compensates by listing each parameter in <parameters> with brief explanations (e.g., 'document: Document name or path (use remarkable_browse to find documents)') and provides three examples showing various combinations. However, it could add more detail about parameter interactions or constraints beyond what the schema enums already convey.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The <usecase> tag states 'Export one reMarkable document as a reusable PDF or Markdown file', providing a specific verb (Export), resource (one reMarkable document), and output format. This clearly distinguishes it from siblings like remarkable_read (read content), remarkable_browse (list documents), and remarkable_upload (import).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The <instructions> explain that the tool exports a single document without modifying the tablet or its library, and the <parameters> section notes that the 'document' parameter can be found using remarkable_browse. While no explicit alternative comparisons are given, the context of sibling names and the detailed examples implicitly guide when to use this tool versus others.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_imageA
Read-onlyIdempotent

Get an image of a specific page from a reMarkable document. Renders a notebook or document page as an image (PNG or SVG). This is useful for:

  • Viewing hand-drawn diagrams, sketches, or UI mockups

  • Getting visual context that text extraction might miss

  • Implementing designs based on hand-drawn wireframes

  • SVG format for scalable vector graphics that can be edited

Merged PDF + Annotation Rendering

PNG pages backed by an imported PDF automatically composite the PDF page with its reMarkable annotations. Set render_merged=False for an annotation-only render, or True to explicitly request compositing. SVG remains annotation-only.

Response Formats

By default, images are returned as embedded resources (EmbeddedResource) which include the full image data inline:

  • PNG: Returned as BlobResourceContents with base64-encoded data

  • SVG: Returned as TextResourceContents with SVG markup

If your client doesn't support embedded resources in tool responses, set compatibility=True to receive a JSON response with just the resource URI. The client can then fetch the resource separately.

Optionally, enable include_ocr=True to extract text from the image using OCR. Google Vision is used when configured; otherwise OCR runs locally with Tesseract.

Note: Native notebooks retain their existing stroke rendering behavior. If older USB firmware returns only a native PDF export, PNG remains available; SVG and explicit annotation-only rendering require an rmdoc archive and return a clear error when it is unavailable.

  • document: Document name or path (use remarkable_browse to find documents)

  • page: Page number (default: 1, 1-indexed)

  • background: Background color as hex code. Supports RGB (#RRGGBB) or RGBA (#RRGGBBAA). Default is "#FBFBFB" (reMarkable paper color), or set REMARKABLE_BACKGROUND_COLOR env var to override. Use "#00000000" for transparent.

  • output_format: Output format - "png" (default) or "svg" for vector graphics

  • compatibility: If True, return resource URI in JSON instead of embedded resource. Use this if your client doesn't support embedded resources in tool responses.

  • include_ocr: Enable OCR text extraction from the image (default: False).

  • render_merged: PDF compositing mode for PNG: None (default) automatically merges PDF-backed pages, True explicitly requests merging, and False returns the annotation-only layer. SVG output remains annotation-only.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNo
documentYes
backgroundNo
include_ocrNo
compatibilityNo
output_formatNopng
render_mergedNo

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is well-covered. The description adds substantial behavioral context beyond annotations: details about merged PDF+annotation rendering behavior, response format differences (PNG as Blob, SVG as Text), compatibility fallback mechanism, OCR behavior (Google Vision vs local Tesseract), and legacy firmware limitations. This is comprehensive behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (usecase, instructions, parameters, examples) and front-loaded purpose. However, it is somewhat verbose for an AI agent tool description—some details about OCR implementation (Google Vision vs Tesseract) and legacy firmware behavior could be in external docs or less critical for initial selection. Still, every section earns its place for a complex tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (7 parameters, 1 required, no output schema), the description is completely sufficient. It covers input semantics, behavioral details (merged rendering, response formats), error cases (legacy firmware), and provides examples for all key parameter configurations. The lack of output schema is compensated by clear explanations of what each format returns (BlobResourceContents, TextResourceContents, JSON with URI).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description fully carries the burden of explaining parameters. It does so excellently: each parameter is described with default values, format requirements (e.g., hex codes for background), behavioral implications (render_merged values), and edge cases (transparent background notation). The examples provide concrete usage patterns that clarify parameter combinations.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Get an image of a specific page from a reMarkable document.' It specifies the verb (Get), resource (image of a page), and scope (from a reMarkable document). The use cases and examples further differentiate it from siblings like remarkable_read (text extraction) and remarkable_canvas (canvas manipulation).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool vs alternatives. The use cases section lists specific scenarios (viewing diagrams, getting visual context, etc.) and the examples cover common invocation patterns. The instructions explain when to use compatibility mode and include_ocr, and the parameters section clarifies when to use render_merged with different document types. Sibling tools like remarkable_export and remarkable_read are implicitly distinguished.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_markdown_to_pdfA

Render Markdown text as a PDF and upload it to the reMarkable tablet. Use this when the user wants notes, reports, summaries, or other Markdown content written back to the tablet without first creating a local file. Headings, lists, tables, links, blockquotes, and code blocks are rendered into a paginated A4 PDF. Raw HTML is escaped and image assets are omitted so rendering never reads local files or fetches remote content.

Works in all three transports:

  • Cloud: sync upload with parent_folder and document_name

  • SSH: filesystem upload with parent_folder and document_name

  • USB web: upload whose multipart filename is document_name + ".pdf"; parent_folder is ignored and the tablet web service chooses the folder.

Requires write mode (the default; disabled with --read-only).

  • markdown: Markdown source text. Must not be empty.

  • document_name: Display name on the tablet (default: "Markdown").

  • parent_folder: Destination folder (default: root "/"). USB web ignores this parameter because its upload endpoint has no folder argument.

  • defer_restart: SSH only. When True, skip the xochitl restart and call remarkable_refresh() once after the batch. Forwarded exactly like remarkable_upload; ignored in cloud and USB web modes.

ParametersJSON Schema
NameRequiredDescriptionDefault
markdownYes
defer_restartNo
document_nameNoMarkdown
parent_folderNo/

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Despite annotations only providing readOnlyHint: false, the description fully discloses behavior: it renders specific Markdown elements (headings, lists, tables, etc.), mentions that raw HTML is escaped and images are omitted, details transport-specific behavior (cloud vs SSH vs USB web), and states it requires write mode. There is no contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear XML tags (usecase, instructions, parameters, examples) and is appropriately sized for the complexity. Every sentence adds value, from rendering details to transport differences. No fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (4 parameters, multiple transports, rendering behavior, and an output schema), the description is comprehensive. It covers transport modes, parameter behaviors, rendering details, and prerequisites (write mode). The presence of examples further enhances completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate—and it does excellently. It explains each parameter with usage notes (e.g., 'Must not be empty' for markdown, defaults, transport-specific behavior like USB web ignoring parent_folder, and defer_restart being SSH-only and forwarded like remarkable_upload). This far exceeds what the schema alone provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific verb 'Render Markdown text as a PDF and upload it to the reMarkable tablet,' which precisely identifies the tool's function and distinguishes it from siblings like remarkable_upload (which uploads existing files) and remarkable_image (which handles images). The usecase tag reinforces the purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The <instructions> explicitly say 'Use this when the user wants notes, reports, summaries, or other Markdown content written back to the tablet without first creating a local file,' providing clear context. It also notes that this tool converts Markdown to PDF, uniquely positioning it among siblings like remarkable_upload which expect pre-made files.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_mkdirA

Create a new folder on the reMarkable tablet. Creates a folder in the tablet's document hierarchy. In SSH mode the folder appears after xochitl restarts; in cloud mode it syncs to all your devices.

Works in cloud and SSH modes (default; --read-only disables). Not available over the USB web interface (the firmware exposes no folder-create endpoint).

  • folder_name: Name of the new folder

  • parent: Parent folder path (default: root "/")

  • defer_restart: SSH only. Skip the xochitl restart so a batch of writes can refresh once via remarkable_refresh() instead of once per write. Sets "refresh_pending": true. Ignored in cloud mode.

ParametersJSON Schema
NameRequiredDescriptionDefault
parentNo/
folder_nameYes
defer_restartNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only provide readOnlyHint (false), so the description carries full burden. It thoroughly discloses behavioral traits: mode differences, the need for xochitl restart in SSH mode, the effect of defer_restart, and the creation delay. No contradictions with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear XML tags (usecase, instructions, parameters, examples). Every sentence adds value—no fluff or repetition. It is appropriately sized for a tool with three parameters and mode-specific behavior.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (multiple modes, three parameters, one required), the description covers all necessary context: mode availability, restart behavior, parent path defaults, and batch hint. An output schema exists but is not needed to explain return values; the description is complete without it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate fully. It explains all three parameters in detail, including defaults, mode-specific behavior, and side effects (e.g., defer_restart sets refresh_pending). The examples show typical usage but do not edge cases.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Create') and resource ('a new folder'), and distinguishes this tool from siblings like remarkable_upload and remarkable_delete. The <usecase> tag clearly states the tool's primary function.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The <instructions> section explicitly describes when to use the tool, including mode-specific behavior (SSH vs cloud) and a clear exclusion: 'Not available over the USB web interface.' It also references the sibling tool remarkable_refresh for batch operations, providing guidance on when to use alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_moveA

Move a document or folder to a different location. Moves a document or folder by updating its parent reference in the metadata. Find the document name with remarkable_browse() first.

Works in cloud and SSH modes (default; --read-only disables). Not available over the USB web interface.

  • document: Name or path of the document/folder to move

  • dest_folder: Destination folder path (use "/" for root)

  • defer_restart: SSH only. Skip the xochitl restart so a batch of writes can refresh once via remarkable_refresh() instead of once per write. Sets "refresh_pending": true. Ignored in cloud mode.

ParametersJSON Schema
NameRequiredDescriptionDefault
documentYes
dest_folderYes
defer_restartNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description transparently discloses that the operation is a mutation (readOnlyHint: false aligns with 'move') and explains the internal action: updating parent reference in metadata. It also reveals behavioral details for SSH mode, such as defer_restart skipping xochitl restart and setting 'refresh_pending': true. There is no contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with <usecase>, <instructions>, <parameters>, and <examples> sections, each serving a distinct purpose. Every sentence adds value—no fluff or repetition. It efficiently conveys purpose, prerequisites, mode restrictions, parameter details, and usage examples in a compact form.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the output schema exists (relieving the description from explaining return values), the description covers all necessary aspects: purpose, prerequisites, mode compatibility, parameter semantics, and behavioral constraints. For a tool with 3 parameters and moderate complexity, this is fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema coverage is 0%, meaning no parameter descriptions exist in the schema. The description's <parameters> section fully compensates by explaining document ('Name or path'), dest_folder ('use "/" for root'), and defer_restart ('SSH only. Skip the xochitl restart...'). This adds substantial meaning beyond the schema's bare type definitions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states 'Move a document or folder to a different location', using a specific verb and resource. It also explains the underlying mechanism ('updating its parent reference') and clarifies it works for both documents and folders. This clearly differentiates it from sibling tools like remarkable_rename or remarkable_delete.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description instructs users to 'Find the document name with remarkable_browse() first', establishing a clear prerequisite. It specifies supported modes (cloud and SSH) and explicitly states unavailability over the USB web interface. It also explains when to use the defer_restart parameter (SSH only). However, it does not explicitly contrast when to use this tool versus alternatives like remarkable_rename, though the context of siblings makes it reasonably clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_readA
Read-onlyIdempotent

Read and extract text content from a reMarkable document. Extracts content from a document with pagination to preserve context window.

Content types:

  • "text" (default): Full extracted text (PDF/EPUB content + annotations)

  • "raw": Original PDF/EPUB text only (no annotations). Works in every transport, as long as the source file is present (very large PDFs/EPUBs may not be synced to the cloud).

  • "annotations": Only annotations, highlights, and handwritten notes

Use pagination to read large documents without overwhelming context:

  • Start with page=1 (default)

  • Check "more" field - if true, there's more content

  • Use "next_page" value to get the next page

  • "total_pages" is the physical document count; "content_pages" is the extracted-text count used by page/more/next_page

  • "total_pages_known" reports whether the physical count was available. Raw PDF reads count the downloaded PDF directly. If a raw EPUB archive cannot be read, content still returns with total_pages=null.

  • If older USB firmware returns only a native PDF, "text" returns source text without annotations and "annotations" reports that the archive is unavailable instead of trying to parse the PDF as a zip.

Use grep to search for specific content on the current page.

OCR uses Google Vision when configured, otherwise Tesseract.

  • document: Document name or path (use remarkable_browse to find documents)

  • content_type: "text" (full), "raw" (PDF/EPUB only), "annotations" (notes only)

  • page: Extracted-content page number (default: 1). Physical document pages are reported separately as total_pages.

  • grep: Optional regex pattern to filter content (searches current page)

  • include_ocr: Enable handwriting OCR for annotations (default: False)

ParametersJSON Schema
NameRequiredDescriptionDefault
grepNo
pageNo
documentYes
include_ocrNo
content_typeNotext

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds rich behavioral detail: pagination mechanics (more, next_page, total_pages, content_pages, total_pages_known), content-specific behavior (text, raw, annotations), handling of older USB firmware, OCR provider fallback, and grep filtering. No contradictions with annotations. The description fully complements the safety profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but well-structured with XML-like tags (usecase, instructions, parameters, examples). It is front-loaded with the core purpose. Every section serves a purpose: pagination details avoid context overflow, parameter explanations prevent misuse, examples show typical invocations. Could be slightly more concise by merging the <instructions> bullet on pagination into fewer sentences, but the organization makes it easy to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (5 parameters, pagination, content types, OCR, firmware edge cases), the description is thorough. It explains output fields like more, next_page, total_pages, content_pages, total_pages_known – and since an output schema exists, it doesn't need to enumerate all return values. It is slightly incomplete on error handling (what if document not found?) and does not mention rate limits or authentication requirements, but these may be covered externally. Overall, it leaves little ambiguity for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage, so the <parameters> section in the description carries the full burden. It explains each parameter with clear semantic meaning: 'document' (name or path, use browse to find), 'content_type' (list of options with outcomes), 'page' (extracted-content page vs physical pages), 'grep' (regex on current page), 'include_ocr' (handwriting OCR). The examples further illustrate parameter usage. This adds significant value beyond the raw schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear '<usecase>Read and extract text content from a reMarkable document.' This specifies a concrete verb and resource. The three content types ('text', 'raw', 'annotations') further clarify what is returned. The tool is well-distinguished from siblings like 'remarkable_image' (image extraction), 'remarkable_export' (export as file), and 'remarkable_search' (search across documents).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides detailed instructions on pagination and grep filtering but does not explicitly state when to use this tool over its siblings. For example, it does not contrast with 'remarkable_export' or 'remarkable_image' for specific use cases. The parameter section advises using 'remarkable_browse to find documents', which implies a prerequisite, but it lacks explicit 'when/when-not' guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_recentA
Read-onlyIdempotent

Get your most recently modified documents. Returns documents sorted by modification date (newest first). Optionally includes a text preview of each document's content.

Use this to quickly find what you were working on recently.

Note: If REMARKABLE_ROOT_PATH is configured, only documents within that folder are included.

  • limit: Maximum documents to return (default: 10, max: 50 without preview, 10 with preview)

  • include_preview: Include first ~200 chars of text content (default: False)

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNo
include_previewNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is clear. The description adds valuable context: sorting order, preview behavior, and the ROOT_PATH filtering. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with usecase, instructions, parameters, and examples tags. It is front-loaded with the main purpose. While the XML-like tags add some verbosity, every section provides distinct value. Could be slightly more concise but not excessive.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 2 simple parameters, complete annotations, and an output schema, the description covers all necessary aspects: use case, parameter details with limits, example invocations, and an environmental note. Nothing essential is missing for a list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description fully compensates by detailing 'limit' with default, max values (50 without preview, 10 with preview) and 'include_preview' with content length (~200 chars). Examples further illustrate usage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Get your most recently modified documents.' with explicit verb+resource. It further specifies sorting by modification date (newest first). This distinguishes it from sibling tools like remarkable_search (query-based) and remarkable_browse (file listing).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance: 'Use this to quickly find what you were working on recently.' It also mentions the REMARKABLE_ROOT_PATH restriction. However, it does not explicitly list when to avoid this tool in favor of alternatives, though the sibling tools context implies distinctions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_renameA

Rename a document or folder on the reMarkable tablet. Changes the display name of a document or folder by updating its metadata. Find the document name with remarkable_browse() first.

Works in cloud and SSH modes (default; --read-only disables). Not available over the USB web interface.

  • document: Current name or path of the document/folder

  • new_name: New display name

  • defer_restart: SSH only. Skip the xochitl restart so a batch of writes can refresh once via remarkable_refresh() instead of once per write. Sets "refresh_pending": true. Ignored in cloud mode.

ParametersJSON Schema
NameRequiredDescriptionDefault
documentYes
new_nameYes
defer_restartNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description goes well beyond the readOnlyHint=false annotation. It explains the core behavior: 'Changes the display name of a document or folder by updating its metadata.' It also details the defer_restart parameter's effect: 'Skip the xochitl restart so a batch of writes can refresh once via remarkable_refresh() instead of once per write. Sets refresh_pending: true. Ignored in cloud mode.' No contradictions with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with dedicated sections (usecase, instructions, parameters, examples) and is front-loaded with the purpose. It is about 150 words, which is appropriate for the complexity. Minor room for trimming, but it's efficient and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity, the description covers purpose, parameters, usage prerequisites, mode restrictions, and examples. It does not mention error handling or return values, but the presence of an output schema likely covers those. The description is complete enough for an AI agent to use the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description carries the full burden. The <parameters> section explains each parameter: document (current name or path), new_name (new display name), and defer_restart (SSH only, restart behavior, ignored in cloud mode). This adds critical meaning beyond the bare schema titles.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Rename a document or folder on the reMarkable tablet.' It uses a specific verb (rename) and resource (document or folder), and the context of sibling tools like remarkable_move, remarkable_delete, and remarkable_upload makes it easy to distinguish from alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides helpful usage guidance: 'Find the document name with remarkable_browse() first' and explains mode availability ('Works in cloud and SSH modes... Not available over the USB web interface'). It also describes the defer_restart parameter for batch operations. It does not explicitly list when not to use the tool, but the context is sufficient for an AI agent to decide appropriately.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_statusA
Read-onlyIdempotent

Check connection status, active transport, and write capabilities. Returns authentication status, the active transport (cloud, local-dir, ssh, or usb-web), the document count, and a capability matrix describing what each transport can do. Use this to verify your connection, choose a transport, or troubleshoot.

Capability notes:

  • Export is available in every transport and creates only a bounded temporary local resource; it never modifies the tablet.

  • Cloud (default): full read/render/export/upload/mkdir/move/rename/delete — no device needed, works from anywhere your token is valid.

  • SSH: full capabilities over a local/USB connection to the tablet.

  • USB web: read, render, export, and upload (to root) only — the tablet's USB web interface firmware exposes no folder/move/rename/delete endpoints. For full write parity over a USB cable, use SSH mode pointed at the USB IP.

  • Local directory: fully offline read/render/export access to the desktop app's sync cache. Strictly read-only to avoid corrupting app-managed state. Write tools (upload/mkdir/move/rename/delete) are enabled by default; run with --read-only (or REMARKABLE_READ_ONLY=1) to expose a read-only server.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the bar is lower. The description adds valuable context about what each transport can and cannot do, how export works (temporary local resource, never modifies tablet), and how to enable write mode. However, it could detail the returned capability matrix structure more explicitly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear XML tags, front-loaded summary, and detailed sections for instructions and examples. It's longer than strictly necessary for a zero-param tool but each section adds value for agent decision-making. Could be slightly more compact.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the zero parameters, present annotations, and existence of an output schema, the description provides everything needed: purpose, transport capabilities, troubleshooting context, and an example. The output schema handles return value details, so the description's coverage is complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are zero parameters, schema coverage is 100%, so the description has no param details to provide. The baseline is 4, and the description includes helpful usage examples and context that compensates for the lack of parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The verb "check" paired with specific resources (connection status, active transport, write capabilities) makes the tool's purpose highly clear. It explicitly distinguishes itself from siblings which focus on file operations or rendering tasks.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool: to verify connection, choose a transport, or troubleshoot. It offers detailed capability breakdowns per transport and explains why write tools are disabled by default, helping the agent decide between alternative transports.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remarkable_uploadA

Upload a PDF or EPUB file to the reMarkable tablet. Uploads a local file to the tablet. Only PDF and EPUB formats are supported. Works in all three transports:

  • Cloud: uploaded via the sync protocol; supports parent_folder + document_name

  • SSH: transferred over SSH, metadata created; supports parent_folder + document_name

  • USB web: uploaded via POST /upload. The multipart filename carries document_name, parent_folder is ignored, and the tablet web service chooses the destination folder.

Requires write mode (the default; disabled with --read-only).

  • file_path: Absolute path to the local PDF or EPUB file

  • parent_folder: Destination folder path on tablet (default: root "/"). Honored in cloud and SSH modes; ignored by the USB web interface.

  • document_name: Display name on tablet (default: filename without extension). Honored in every mode; USB web uses it as the uploaded filename.

  • defer_restart: SSH only. When True, skip the xochitl restart that normally makes the upload visible. Use this for every upload in a batch, then call remarkable_refresh() ONCE at the end. Each restart forces a full document-store rescan that briefly destabilises the SSH link, so deferring turns N restarts (and N races) into one. The response sets "refresh_pending": true while a refresh is owed. Ignored in cloud/USB modes (no xochitl).

ParametersJSON Schema
NameRequiredDescriptionDefault
file_pathYes
defer_restartNo
document_nameNo
parent_folderNo/

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description reveals extensive behavioral traits beyond the readOnlyHint=false annotation: requires write mode, transport-specific behaviors (USB web ignores parent_folder, SSH supports defer_restart), and the consequences of restarts (destabilisation, refresh_pending). This fully informs the agent of side effects and constraints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with XML tags (usecase, instructions, parameters, examples), front-loading the core purpose. Every sentence adds value, covering transport modes, batch patterns, and edge cases without redundancy. It is efficient and highly readable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (4 parameters, 3 transports, batch behavior) and the presence of an output schema, the description is complete. It covers all parameters, transport-specific nuances, batch usage, and response hints, leaving no gaps for an agent to interpret.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description compensates fully by explaining each parameter: file_path (absolute path), parent_folder (default '/', transport-honored), document_name (default filename without extension), and defer_restart (SSH-only, batch usage, response flag). It adds critical meaning absent from the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states 'Upload a PDF or EPUB file to the reMarkable tablet', using a specific verb and resource. It clearly distinguishes from sibling tools like remarkable_image (for images) and remarkable_markdown_to_pdf (conversion) by specifying supported formats and transport modes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use the tool (uploading local files) and includes instructions for different transports and batch usage. However, it does not explicitly exclude alternatives like remarkable_image for image uploads, leaving a minor gap in when-not-to-use guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 8 tool updatesv2.1.0
    • Changedremarkable_delete2 fields changed
      • addedInput schema / properties / defer_restart
        Added value: +{
        +  "default": false,
        +  "title": "Defer Restart",
        +  "type": "boolean"
        +}
      • addedInput schema / properties / permanent
        Added value: +{
        +  "default": false,
        +  "title": "Permanent",
        +  "type": "boolean"
        +}
    • Addedremarkable_export
    • Changedremarkable_image3 fields changed
      • addedInput schema / properties / render_merged / anyOf
        Added value: +[
        +  {
        +    "type": "boolean"
        +  },
        +  {
        +    "type": "null"
        +  }
        +]
      • changedInput schema / properties / render_merged / default
        Previous value: -falseNew value: +null
      • removedInput schema / properties / render_merged / type
        Removed value: -"boolean"
    • Addedremarkable_markdown_to_pdf
    • Changedremarkable_mkdir1 field changed
      • addedInput schema / properties / defer_restart
        Added value: +{
        +  "default": false,
        +  "title": "Defer Restart",
        +  "type": "boolean"
        +}
    • Changedremarkable_move1 field changed
      • addedInput schema / properties / defer_restart
        Added value: +{
        +  "default": false,
        +  "title": "Defer Restart",
        +  "type": "boolean"
        +}
    • Changedremarkable_rename1 field changed
      • addedInput schema / properties / defer_restart
        Added value: +{
        +  "default": false,
        +  "title": "Defer Restart",
        +  "type": "boolean"
        +}
    • Changedremarkable_upload1 field changed
      • addedInput schema / properties / defer_restart
        Added value: +{
        +  "default": false,
        +  "title": "Defer Restart",
        +  "type": "boolean"
        +}
  2. 12 tool updatesv0.1.0
    • First observedremarkable_browse
    • First observedremarkable_canvas
    • First observedremarkable_delete
    • First observedremarkable_image
    • First observedremarkable_mkdir
    • First observedremarkable_move
    • First observedremarkable_read
    • First observedremarkable_recent
    • First observedremarkable_rename
    • First observedremarkable_search
    • First observedremarkable_status
    • First observedremarkable_upload

TDQS

A4.6/5.0

Scored across 14 tools

Disambiguation5/5

Each tool targets a distinct operation: browsing, searching, reading text, exporting documents, rendering images, opening an interactive viewer, uploading, creating folders, moving, renaming, deleting, and checking status. While read, export, image, and canvas all retrieve content, their output formats and use cases are clearly different. No two tools have overlapping purposes.

Naming Consistency5/5

All 14 tools follow a consistent 'remarkable_verb' or 'remarkable_noun' pattern in snake_case. Verbs are imperative where applicable (upload, move, rename, delete, search, browse, read) and nouns (status, canvas) are clear. No mixing of camelCase or inconsistent prefixes. The pattern is predictable and intuitive.

Tool Count5/5

14 tools is well-scoped for a reMarkable tablet management server. It covers document retrieval (read, export, image, canvas), library navigation (browse, search, recent), file management (upload, mkdir, move, rename, delete), content creation (markdown_to_pdf), and status checking. Neither too sparse nor overwhelming.

Completeness4/5

The tool set provides full CRUD-like coverage for documents and folders, including browse, search, read, export, render, upload, create folder, move, rename, and delete. Minor gaps exist: no tool to list all tags independently, and annotation editing is absent, but these are not core to typical MCP workflows. Overall, the surface is thorough for the domain.

Maintenance

ActivityMaintained
ResponsivenessWithin a week

Related MCP Connectors

Related MCP Servers

  • A
    license
    Not graded
    quality
    D
    maintenance
    Enables AI assistants to browse and read documents from a reMarkable tablet connected via USB, rendering PDF pages as images for the AI to see.
    Apache 2.0
  • A
    license
    A
    quality
    D
    maintenance
    Enables reading and searching handwritten notes from GoodNotes on macOS, providing OCR text, search, and notebook management tools for AI assistants.
    6
    MIT