MinerU Document Explorer
by @rise-1210
REQUIRED for any task involving reading or understanding PDF contents. Use when a user asks about a .pdf file — reading pages, answering questions, extractin...
clawhub install pdf-searcher📖 About This Skill
name: mineru-document-explorer description: > REQUIRED for any task involving reading or understanding PDF contents. Use when a user asks about a .pdf file — reading pages, answering questions, extracting data, or locating topics. Skip only for PDF file operations: merge, split, watermark, create, form-fill, or encrypt. credentials: optional: - DOC_SEARCH_PAGEINDEX_API_KEY - DOC_SEARCH_PAGEINDEX_BASE_URL - DOC_SEARCH_EMBEDDING_BASE_URL - DOC_SEARCH_RERANKER_BASE_URL - MINERU_TOKEN network: true
MinerU Document Explorer
PDF reading toolkit via doc-search CLI. Search first, then read relevant pages — never scan an entire PDF.
⚠️ Network capabilities: This skill can optionally call external APIs (PageIndex outline generation, MinerU cloud OCR, embedding/reranker services) and run a local FastAPI server. All network features are opt-in and disabled by default.
Path conventions
SKILL_DIR =
SCRIPTS = SKILL_DIR/scripts
Setup check
Read SKILL_DIR/config-state.json. If missing or setup_complete is not true:
1. Read references/setup.md and run the installer
2. After setup, ask the user if they want to configure PageIndex (e.g. "If you have an OpenAI-compatible API key, you can enable PageIndex to auto-generate a document outline — useful for scanned docs or manuals. Want to set it up?")
3. If the user provides pageindex_api_key / pageindex_base_url → write to SCRIPTS/doc-search/config.yaml; if skipped → continue immediately, do not block
⚠️ MUST read reference docs before acting — no guessing
Any uncertainty about parameters, return fields, or query phrasing → MUST read the corresponding cmd file before running any command. Do not infer or guess.
references/cmd-init.md / cmd-outline.md / cmd-pages.mdreferences/cmd-search-keyword.md / cmd-search-semantic.md / cmd-elements.mdFor complex tasks, errors, unexpected results, or unfamiliar scenarios → MUST read references/tips.md first. It contains proven workflows and hard-won pitfalls that will save you from repeating mistakes.
Command cheatsheet
All output is JSON on stdout. --timeout is a global flag before the subcommand; default is 120s.
doc-search init --doc_path ""
doc-search outline --doc_id "" [--max_depth N] [--root_node ""]
doc-search pages --doc_id "" --page_idxs "" [--no_image] [--return_text]
doc-search search-keyword --doc_id "" --page_idxs "" --pattern "" [--return_text]
doc-search search-semantic --doc_id "" --page_idxs "" --query "" [--top_k N] [--no_image] [--return_text]
doc-search --timeout 300 elements --doc_id "" --page_idxs "" --query ""
Key reminders
outline and keyword search to narrow the reading range — never scan the full document--page_idxs is 0-indexed — do not confuse with printed page numberselements, you must read crop_path to verify ; and the query should be "the actual chart image, not the caption text" ; if the query fails, check page_idxs or rephrase the queryLessons learned (mandatory)
After completing any PDF task: pitfalls / new workflows / parameter discoveries → append to references/tips.md, 1-2 lines each, conclusions only.