research-library

What This Skill Does

The Research Library skill is a dedicated local-first multimedia repository designed specifically for the rigorous demands of hardware engineering and complex technical projects. Unlike general-purpose note-taking apps, this tool is architected to handle the heterogeneous data types common in hardware design, including CAD files, source code, schematics, and technical manuals. It automatically extracts metadata from your files—such as function signatures from code, text from PDF datasheets, and EXIF data from project images—using an asynchronous processing queue that ensures your primary workspace remains responsive. By employing SQLite 3.45 with FTS5, the library provides blazing-fast full-text search capabilities, enhanced by a unique material-type weighting system that prioritizes your verified reference materials over raw research notes. The inclusion of project isolation features ensures that technical data remains cleanly siloed, preventing context contamination between unrelated developments.

Installation

To integrate the Research Library into your OpenClaw environment, use the ClawHub package manager. Run the following command in your terminal:

clawhub install openclaw/skills/skills/jonbuckles/research-library

Alternatively, if you are working from a local clone, you can install the package directly via pip:

pip install /path/to/research-library

Ensure your system meets the requirements for SQLite 3.45+ to utilize the advanced FTS5 virtual table features.

Use Cases

• Project Archiving: Maintain a permanent, searchable history of CAD iterations and firmware versions for specific hardware builds.
• Datasheet Management: Quickly locate specific voltage thresholds or pinout configurations across hundreds of PDF manuals without manual organization.
• Knowledge Linking: Create meaningful relationships between disparate concepts, such as linking a specific motor control algorithm in your code repository to a mechanical servo tuning guide.
• Regulatory Compliance: Use the 30-day automated backup and export functions to maintain records of research and design documentation.

Example Prompts

1. "OpenClaw, search my research library for 'servo tuning' within the 'rc-quadcopter' project and link the top result to my current motor calibration document."
2. "Add the file '~/downloads/stepper_driver_datasheet.pdf' to the 'cnc-build' project as a reference material and trigger a metadata extraction."
3. "Show me all tagged 'experiment' items related to 'PID tuning' and export them to a markdown file for my final report."

Tips & Limitations

• Weighting: Always assign a 'reference' type to verified documents, as this boosts their search ranking to 1.0, ensuring critical info appears first.
• System Resources: The skill uses configurable async workers. If you are importing large batches of high-resolution CAD or PDF files, consider increasing your 'num_workers' in the config, provided your machine has the CPU overhead.
• Storage Constraints: Be mindful of the 'project_size_limit_gb' setting in the configuration to prevent your local SSD from filling up with high-density schematics and image assets.
• Data Safety: While the 30-day backup rotation is robust, ensure that the designated 'backup_dir' resides on a secondary drive or reliable cloud-synced path to prevent data loss in the event of local hardware failure.