MinerU

mineru-mcp

MCP server and mineru-cloud CLI for the MinerU document parsing API, with complete artifact retention, durable operations, and portable PDF bundles.

Durable operations and bundles in this checkout are unreleased. The published mineru-mcp@1.2.0 does not include them; npm users need a release containing these changes.

Features

• VLM model — Document parsing with a vision-language model
• Pipeline model — Document parsing with the pipeline model
• Local file upload — Upload files from disk for batch parsing
• Batch processing — Submit multiple documents in one request
• Download & rename — Extract markdown with original filenames
• Page ranges — Extract specific pages only
• Long documents — mineru_parse_long submits page-range slices and mineru_merge_slices stitches
• CLI twin — mineru-cloud calls the same tools from a shell
• Language and OCR options — Select a language and enable OCR for the pipeline model

Tools

Installation

Use Node.js 24 for new installations. Node.js 18+ remains supported for compatibility. Cloud commands require a MinerU API key; offline bundle creation requires no credentials.

Local output retention, bundles, and durable operations require macOS or Linux. These paths use directory-bound filesystem operations and fail closed on Windows; the Windows client configuration below does not imply local retention support.

CLI Install (one-liner)

# Claude Code

claude mcp add mineru-mcp -e MINERU_API_KEY=your-api-key -- npx -y mineru-mcp

Codex CLI (OpenAI)

codex mcp add mineru --env MINERU_API_KEY=your-api-key -- npx -y mineru-mcp

Gemini CLI (Google)

gemini mcp add -e MINERU_API_KEY=your-api-key mineru npx -y mineru-mcp

Claude Desktop

Add to your claude_desktop_config.json:

{

"mcpServers": { "mineru": { "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } } } }

VS Code

Add to .vscode/mcp.json (workspace) or open Command Palette > MCP: Open User Configuration (global):

{

"servers": { "mineru": { "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } } } }

Note: VS Code uses "servers" as the top-level key, not "mcpServers". Other VS Code forks (Trae, Void, PearAI, etc.) typically use this same format.

Cursor

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (project):

{

"mcpServers": { "mineru": { "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } } } }

Windsurf

Add to ~/.codeium/windsurf/mcp_config.json (Windows: %USERPROFILE%\.codeium\windsurf\mcp_config.json):

{

"mcpServers": { "mineru": { "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } } } }

Cline

Open MCP Servers icon in Cline panel > Configure > Advanced MCP Settings, then add:

{

"mcpServers": { "mineru": { "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } } } }

Cherry Studio

In Settings > MCP Servers > Add Server, set Type to STDIO, Command to npx, Args to -y mineru-mcp, and add environment variable MINERU_API_KEY. Or paste in JSON/Code mode:

{

"mineru": { "name": "MinerU", "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" }, "isActive": true } }

Witsy

In Settings > MCP Servers, add a new server with Type: stdio, Command: npx, Args: -y mineru-mcp, and set environment variable MINERU_API_KEY to your API key.

Codex CLI (TOML config)

Alternatively, edit ~/.codex/config.toml directly:

[mcp_servers.mineru]

command = "npx" args = ["-y", "mineru-mcp"]

[mcp_servers.mineru.env] MINERU_API_KEY = "your-api-key"

Gemini CLI (JSON config)

Alternatively, edit ~/.gemini/settings.json directly:

{

"mcpServers": { "mineru": { "command": "npx", "args": ["-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } } } }

Windows

On Windows, npx requires a shell wrapper. Replace "command": "npx" with:

{

"command": "cmd", "args": ["/c", "npx", "-y", "mineru-mcp"], "env": { "MINERU_API_KEY": "your-api-key" } }

For CLI tools on Windows:

claude mcp add mineru-mcp -e MINERU_API_KEY=your-api-key -- cmd /c npx -y mineru-mcp

codex mcp add mineru --env MINERU_API_KEY=your-api-key -- cmd /c npx -y mineru-mcp

ChatGPT

ChatGPT only supports remote MCP servers over HTTPS — local stdio servers like this one are not directly supported. You would need to deploy behind a public URL with HTTP transport.

CLI: mineru-cloud

Every tool is also a shell command — the CLI runs the MCP server in-process over an in-memory transport, so the two can't drift. Same env vars (MINERU_API_KEY, MINERU_BASE_URL, MINERU_DEFAULT_MODEL).

mineru-cloud list                                    # commands + options (from the tool schemas)

mineru-cloud parse --url https://arxiv.org/pdf/2303.08774 --pages 1-10 mineru-cloud status --task-id --wait # --wait polls every 10s until done/failed mineru-cloud batch --urls '["https://…/a.pdf","https://…/b.pdf"]' mineru-cloud download-results --batch-id --output-dir ./papers --wait

Long document: slice, then stitch

mineru-cloud parse-long --url https://…/book.pdf --total-pages 520 --name book mineru-cloud merge-slices --batch-id --output-dir ./books --wait

Options mirror the tool parameters with _ → - (--total-pages, --output-dir); numbers, true/false and JSON arrays are coerced. Install: bun add -g mineru-mcp (or npm i -g).

Offline artifact bundles

Create a portable Scholia v1.0.1 bundle from an existing provider ZIP and the exact source PDF. This command runs offline and does not require an API key:

mineru-cloud bundle --source /absolute/source.pdf --archive /absolute/result.zip \

--output /absolute/bundles --json

The command returns bundle_dir, an immutable directory containing bundle.json, the original PDF, and the byte-identical ZIP. Move the entire directory for import. Repeated inputs verify the existing bytes and return the same bundle. Optional --batch-id and --model record caller-supplied metadata. --binding caller_asserted records a qualified association; the default is unknown. Neither choice proves that the provider parsed those exact PDF bytes. The command does not infer page coverage, requested options, or provider versions from filenames.

Only PDF sources qualify for this bundle. Existing non-PDF cloud commands remain available and produce diagnostic inventories. Unsafe archives are retained in quarantine, outside importable bundles. ZIP64, encrypted archives, special files, ambiguous legacy filename encodings, and unsafe or colliding paths are rejected.

Complete downloads and structured status

download-results retains each ZIP under {name}/archives/ .zip and writes an inventory.json covering every member, including unknown formats. It also creates legacy {name}.md, {name}_content.json, and image copies when selection is unambiguous. A missing or ambiguous Markdown file does not discard the archive. No shell unzip executable is used. Inventory hashes expanded bytes incrementally; selected compatibility copies have a separate 64 MiB size limit.

Use --json on lifecycle commands for structured operation IDs, normalized state, pollability, counts, and errors. --wait uses typed state across the whole batch, including entries outside the displayed page. It polls every 10 seconds for up to 30 minutes. A failed entry does not hide other pending entries. Unknown provider states remain explicit. Exit status is 1 for failure and 2 for partial or unknown results. The 8 existing MCP tool names and their CLI commands remain available.

Slice merges retain each archive under a hash-qualified directory. Earlier image links remain valid after a successor merge. The merged content JSON is a slice receipt with archive references, rather than a flattened array with assumed page offsets. Missing Markdown or failed slices produce an explicit partial result; otherwise coverage and original PDF page provenance remain unknown.

Durable standalone operations

The 6 additional commands share their implementation with MCP:

mineru-cloud capabilities --api v4 --json

mineru-cloud submit --file /absolute/source.pdf --api v4 --model vlm --output-dir /absolute/results --json mineru-cloud operation-status --operation-id ID --json mineru-cloud resume --operation-id ID --wait --wait-timeout-seconds 1800 --json mineru-cloud cancel --operation-id ID --json mineru-cloud bundle --operation-id ID --json

MINERU_STATE_DIR selects the journal root; the default is ~/.local/share/mineru-cloud. Keep that directory for recovery. The journal retains source bytes, request fingerprints, remote IDs, completed output hashes, and phase checkpoints. Credentials and signed URLs stay in process memory. Exact duplicate submissions join the recorded operation. A lost allocation or job ID requires reconciliation and never triggers automatic resubmission. An ambiguous V4 upload with a saved batch ID resumes by polling that batch. V1 inspects a known upload before continuing an uncertain completion.

One process holds the writer lock at a time. Normal dead-process locks can be reclaimed with an owner-token check. An interrupted lock-recovery step or a reused PID fails closed with an explicit busy/recovery error. This filesystem journal is separate from Scholia's SQLite lease and reservation system; it does not claim Scholia's worker scheduling or maintenance guarantees.

operation-status reads locally unless --refresh is supplied. resume continues a safe checkpoint. Finalization uses saved outputs without contacting the provider. Local cancellation does not cancel remote processing or remove uploaded data. Remote cancellation and automatic lost-ID association remain unsupported. Completed bundles preserve archives and every detached output, including unknown formats. Provider transport completion does not establ