DocsAgent

v1.0.1

Search and manage private, local document collections (PDF, PPTX, DOCX) offline. Use when you need to find information within your private files, not for web...

4· 110·0 current·0 all-time

Install

OpenClaw Prompt Flow

Install with OpenClaw

Best for remote or guided setup. Copy the exact prompt, then paste it into OpenClaw for docsagent/docsagent.

Previewing Install & Setup.
Prompt PreviewInstall & Setup
Install the skill "DocsAgent" (docsagent/docsagent) from ClawHub.
Skill page: https://clawhub.ai/docsagent/docsagent
Keep the work scoped to this skill only.
After install, inspect the skill metadata and help me finish setup.
Use only the metadata you can verify from ClawHub; do not invent missing requirements.
Ask before making any broader environment changes.

Command Line

CLI Commands

Use the direct CLI path if you want to install manually and keep every step visible.

OpenClaw CLI

Bare skill slug

openclaw skills install docsagent

ClawHub CLI

Package manager switcher

npx clawhub@latest install docsagent
Security Scan
VirusTotalVirusTotal
Benign
View report →
OpenClawOpenClaw
Benign
medium confidence
Purpose & Capability
Name, description, and instructions all describe a CLI tool to index and search local PDF/PPTX/DOCX files; required capabilities and declared requirements (none) match that purpose.
Instruction Scope
SKILL.md confines operations to indexing and searching local files and instructs only CLI commands (add, search, list, status, stop). However, it asserts a strong privacy guarantee (“100% local”) that cannot be verified from the instruction file alone — the actual runtime behavior depends on the external npm package it directs you to install.
Install Mechanism
The registry has no formal install spec (skill is instruction-only) but the README suggests installing @docsagent/docsagent from npm and links to a GitHub repo. npm packages are a normal distribution method for CLI tools but do introduce network/third-party code risk; the skill itself does not perform any install actions, so verifying the package source is your responsibility.
Credentials
The skill requests no environment variables, no credentials, and no configuration paths — consistent with a local-only document indexer.
Persistence & Privilege
Skill is not always-enabled and does not request elevated or persistent platform privileges. There is no instruction to modify other skills or global agent configuration.
Assessment
This skill is coherent for local document search, but it relies on an external npm package you would install. Before installing or running it: (1) inspect the npm package and its GitHub repository (package.json, source, maintainers, open issues) to confirm it truly runs locally and has no telemetry; (2) prefer auditing the package code or running it in a sandbox/container before giving it access to sensitive folders; (3) when indexing, limit the paths you add so the tool only reads intended directories; (4) don't assume the SKILL.md privacy promise is enforceable — verify network activity (e.g., with firewall/packet capture) if you must ensure no data leaves your machine.

Like a lobster shell, security has layers — review code before you run it.

latestvk97cyxt5yyd3qh51zj8wvg6j9184pwxy
110downloads
4stars
2versions
Updated 2w ago
v1.0.1
MIT-0

DocsAgent Skill

DocsAgent is a local-first documentation engine designed to perform lightning-fast hybrid search (text and semantic search) over your private local files.

Key Features

  • Privacy-First: All indexing and searching happen 100% locally on your machine. No documents or data ever leave your system.
  • Hybrid Search: Combines semantic and keyword-based text search for high accuracy.
  • Supported Formats: Optimized for PDF, PPTX, and DOCX files.
  • No Web Dependency: This tool does not perform web searches. It relies on a local index you create.

Privacy Guarantee

  • 100% Local: All processing, indexing, and search operations are performed entirely on your machine.
  • Zero Data Leakage: No data is sent to external servers. Your documents remain private.

When to use

  • Use this when searching for information within your own private documentation, research papers, reports, or presentations.
  • Do not use this for general internet queries, news, or public website information.

Installation

DocsAgent is a CLI toolkit, when you install the global docsagent package, You can directly use 'docsagent' command.

npm install @docsagent/docsagent

For more information, please see https://github.com/docsagent/docsagent.

Usage Guidelines

1. Add Documentation

Adds directory or file paths (PDF, DOCX, PPTX) to the index. You can pass multiple paths at once.

# Add a single directory
docsagent add ./documents/manuals

# Add multiple files and directories at once
docsagent add ./reports/q1.pdf ./presentation.pptx ./notes/meeting-files
  • Use case: Use to index folders or specific private files for searchability.

2. Search Documents

Performs a hybrid search (text + semantic) across your indexed private documents.

# Search for a specific topic
docsagent search "how to configure local encryption"

# Search for technical concepts
docsagent search "API authentication process"

The tool returns the most relevant snippets with their source paths and scores.

  • Important: Ensure your documents have been indexed using the add operation before searching.

3. List Indexed Sources

Lists all files currently being monitored or indexed.

docsagent list

4. Check Status

Shows the indexing progress and service health.

docsagent status

5. Stop Agent

Stops the indexing service.

docsagent stop

Workflow: Answering Questions from Local Docs

  1. Check Index: If unsure if the documents are indexed, you can try a search first.
  2. Search: Execute search with a specific query derived from the user's request.
  3. Analyze: Review the context returned. If multiple snippets are found, synthesize them into a coherent answer.
  4. Cite Sources: Always mention the file path and page number (if available) in your response.

Error Handling

  • If search returns "No results found", inform the user and ask if they want to index a specific directory using add.
  • If a path is not found during add, verify the path exists before retrying.

Comments

Loading comments...