Skip to main content
Glama
praveensehgal

io.github.praveensehgal/remarkable

remarkable_read

Read-onlyIdempotent

Read and extract text, annotations, and handwriting from reMarkable documents. Supports pagination and search for large files.

Instructions

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). SSH mode only.

  • "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

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

When REMARKABLE_OCR_BACKEND=sampling is set and the client supports sampling, OCR will use the client's LLM for handwriting recognition (no API keys needed).

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

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

  • page: Page number (default: 1). For notebooks, this is the notebook page.

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

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentYes
content_typeNotext
pageNo
grepNo
include_ocrNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Annotations declare readOnlyHint=true, destructiveHint=false. The description adds behavioral context beyond annotations: pagination mechanism, content extraction types, grep filtering, OCR backend behavior, and per-parameter details. 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?

Description is well-structured with clear usecase, instructions, parameters, and examples. Front-loaded with purpose, each sentence adds value. No redundancy or waste.

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 5 parameters and output schema (present but not shown), the description fully covers usage scenarios, pagination, content types, grep, OCR, and error context (via examples). It mentions the 'more' field and 'next_page' for pagination, compensating for schema gaps.

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 has 0% description coverage. The description fully explains each parameter: document (use remarkable_browse to find), content_type (enum meanings), page (default 1, notebook pages), grep (regex on current page), include_ocr (default false). Examples reinforce 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 'Read and extract text content from a reMarkable document.' It uses a specific verb and resource, distinguishing it from sibling tools like remarkable_browse (browse) and remarkable_search (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 instructions provide detailed usage guidance on pagination, content types, grep, and OCR. It implicitly differentiates from siblings but lacks explicit 'when-not-to-use' or direct alternative comparisons.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/praveensehgal/remarkable-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server