← Back to Skills Marketplace
mrchenkuan

large-document-reader

by 陈宽同学 · GitHub ↗ · v1.0.2
cross-platform ⚠ suspicious
535
Downloads
0
Stars
4
Active Installs
3
Versions
Install in OpenClaw
/install large-document-reader
Description
Intelligently splits long academic or technical documents into chapters, generates structured JSON summaries for each, and creates a file system with a globa...
README (SKILL.md)

Literature Structuring Expert

Automatically decompose long documents (papers, reports, books) into a structured, AI-friendly knowledge base. Splits by chapter, generates machine-readable summaries, and builds a navigable index to overcome context limits.

When to Use This Skill

Use this skill when the user:

  • Has a document that is too long for the AI's context window.
  • Needs to perform cross-chapter analysis or get a high-level overview of a long text.
  • Wants to build a reusable, queryable knowledge base from a PDF, Markdown, or text file.
  • Asks: "How can I get my AI to read this whole book/paper?"

Quick Reference

Situation Action
User provides a long document 1. Analyze and split it into chapters.\x3Cbr>2. Generate a JSON summary for each chapter.\x3Cbr>3. Create a master index file.
User asks a high-level, cross-chapter question Provide the content of the MASTER_INDEX.md file to the AI.
User asks a detailed, chapter-specific question Provide the corresponding single file from the ./chapters/ directory to the AI.
Task completed Present the generated file tree and MASTER_INDEX.md preview to the user.

Core Workflow

Phase 1: Intelligent Splitting

  1. Analyze Input: Receive the long document text or file path.
  2. Identify Structure: Automatically analyze the document to identify heading hierarchies (e.g., #, ##, 1., 1.1) to determine chapter boundaries. Prioritize user-specified splitting preferences.
  3. Execute Split: Split the document into independent plain-text files by chapter.
    • Naming Convention: {sequence_number}_{chapter_title}.md (e.g., 01_Introduction.md).
    • Storage Location: All chapter files are saved in the ./chapters/ directory.

Phase 2: Summary Generation & Structuring

  1. Generate Summary per Chapter: For each file in ./chapters/, generate a corresponding JSON summary file.
    • Structured Fields (JSON format):
      {
        "chapter_id": "Unique identifier matching the filename, e.g., 02_1",
        "chapter_title": "Chapter Title",
        "abstract": "Core summary of the chapter, 200-300 words.",
        "keywords": ["Keyword1", "Keyword2", "Keyword3"],
        "key_points": ["Key point one", "Key point two"],
        "related_sections": ["IDs of other chapters strongly related to this one"]
      }
      
    • Storage Location: JSON summary files are saved in the ./summaries/ directory (e.g., 01_Introduction.summary.json).

Phase 3: Create Global Index

  1. Aggregate Information: Collect data from all JSON files in ./summaries/.
  2. Generate Index: Create a global index file, MASTER_INDEX.md.
    • Content: Lists all chapters' IDs, titles, a short abstract preview, and keywords in a Markdown list or table.
    • Purpose: Provides a "bird's-eye view" for quick navigation and high-level Q&A.

Final Deliverables & File Structure

Upon completion, the following file tree is generated:

Project_Root/
├── chapters/           # 【Source Repository】Contains all split chapter texts (.md files)
│   ├── 01_Introduction.md
│   ├── 02_1_Experimental_Methods.md
│   └── ...
├── summaries/          # 【Summary Repository】Contains all structured JSON summaries
│   ├── 01_Introduction.summary.json
│   ├── 02_1_Experimental_Methods.summary.json
│   └── ...
└── MASTER_INDEX.md     # 【Global Navigation】Core document summary index

Usage Instructions for the User

For Global, Cross-Chapter Queries (e.g., “What is the paper's main thesis?”):

  • Provide the content of the MASTER_INDEX.md file to the AI. This is token-efficient.

For Specific, In-Depth Queries Within a Chapter (e.g., “What were the parameters in the 'Methods' section?”):

  • Provide the corresponding single chapter file from the chapters/ directory to the AI for full context.
Usage Guidance
Do not run this skill as-is. The package contains developer-specific absolute paths and does not implement the summary/index functionality claimed in the README. Before using: (1) Review and edit scripts to accept a user-supplied file path (avoid hard-coded paths), (2) change output locations to a safe, documented directory (relative to the current working directory), (3) verify there are no network calls or other unexpected I/O, and (4) test in a sandboxed environment with non-sensitive documents. If you don't want to edit code yourself, ask the author for a corrected release that implements summaries and index generation and removes hard-coded paths. The behavior looks like sloppy packaging rather than overtly malicious, but the inconsistencies and absolute paths are a privacy and operational risk.
Capability Analysis
Type: OpenClaw Skill Name: large-document-reader Version: 1.0.2 The skill is classified as suspicious due to critical vulnerabilities in the Python scripts. Both `scripts/extract_chapters.py` and `scripts/save_chapters.py` contain hardcoded absolute file paths (e.g., `/Users/chenkuan/Desktop/毕业论文/...` and `/Users/chenkuan/.openclaw/workspace/...`). While there is no evidence of malicious intent like data exfiltration or unauthorized execution, these hardcoded paths make the skill non-portable and non-functional outside a specific developer's environment. This represents a significant design flaw and a potential security vulnerability if the agent's execution environment is not strictly sandboxed or if these paths could be manipulated by an attacker.
Capability Assessment
Purpose & Capability
SKILL.md claims splitting, per-chapter JSON summaries, and a MASTER_INDEX.md. The shipped Python scripts only extract chapter boundaries and write chapter files; there is no implementation of summary generation or index creation. Also, the scripts use absolute paths specific to a developer's machine (/Users/chenkuan/...), which is inconsistent with a generic document-processing skill.
Instruction Scope
The runtime instructions describe taking a user-provided document path and producing ./chapters/ and ./summaries/. The actual code ignores an external input and reads a hard-coded file from the developer's Desktop, then writes a chapters_info.json into a hard-coded workspace path. This is scope creep and unexpected file access not described in SKILL.md.
Install Mechanism
No install spec is provided (instruction-only plus two scripts). Nothing is downloaded or executed from remote URLs, which reduces supply-chain risk.
Credentials
No environment variables or credentials are requested (appropriate). However, the code directly accesses absolute local filesystem paths (a specific user's Desktop and home .openclaw workspace), which could inadvertently read sensitive local files if those paths exist in the runtime environment.
Persistence & Privilege
The skill is not always-enabled and does not request elevated platform privileges. It writes files to disk (chapters_info.json and chapter .md files) within paths referenced in the scripts; it does not attempt to modify other skills or global agent settings.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install large-document-reader
  3. After installation, invoke the skill by name or use /large-document-reader
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.2
- Added new scripts: extract_chapters.py and save_chapters.py, enabling chapter extraction and saving functionality. - No changes made to documentation or user-facing features.
v1.0.1
rename
v1.0.0
Intelligently splits long academic or technical documents into chapters, generates structured JSON summaries for each, and creates a file system with a global index. This enables efficient AI retrieval and analysis, perfectly solving context window limitations by enabling “overview via summaries, deep-dive on demand” workflows.
Metadata
Slug large-document-reader
Version 1.0.2
License
All-time Installs 4
Active Installs 4
Total Versions 3
Frequently Asked Questions

What is large-document-reader?

Intelligently splits long academic or technical documents into chapters, generates structured JSON summaries for each, and creates a file system with a globa... It is an AI Agent Skill for Claude Code / OpenClaw, with 535 downloads so far.

How do I install large-document-reader?

Run "/install large-document-reader" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is large-document-reader free?

Yes, large-document-reader is completely free (open-source). You can download, install and use it at no cost.

Which platforms does large-document-reader support?

large-document-reader is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created large-document-reader?

It is built and maintained by 陈宽同学 (@mrchenkuan); the current version is v1.0.2.

💬 Comments