Skip to content
View docsagent's full-sized avatar

Block or report docsagent

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
docsagent/README.md

DocsAgent πŸ›‘οΈ

The High-Performance Local Intelligence Layer for AI Agents.

DocsAgent is a professional, local-first documents intelligence engine and MCP (Model Context Protocol) server. It provides a secure, near-instant bridge between your private local files and advanced agentic platforms like OpenClaw, Claude Code, and Cursor.

100% Local. 100% Private. Zero Data Leakage.

License: Apache-2.0 OS: macOS / Windows / Linux


πŸ”₯ Why DocsAgent?

Modern AI Agents are incredibly smart, but they are "blind" to your private desktop documents. DocsAgent acts as a High-Performance Intelligence Engine that indexes your local data, allowing agents to search, read, and analyze thousands of files (1,000+) with absolute privacy.

  • πŸ”’ Absolute Privacy: All document parsing, indexing, and vector storage happen strictly on your own hardware. Your data never leaves your machine.
  • ⚑ High-Performance Core: Powered by a native C++ engine. Experience millisecond-level retrieval even across massive document libraries.
  • πŸ”Œ MCP Native: Built-in support for the Model Context Protocol (MCP), making it instantly compatible with the latest AI tools.
  • πŸ“‚ Format Mastery: Native parsing for PDF, Word (.docx), PPTX.

πŸš€ Quick Start

πŸ“„ SKILL.md

This file provides detailed instructions and guidelines for using the DocsAgent skill, including its purpose, features, and usage examples. SKILL.md


1. Install via NPM

npm install -g @docsagent/docsagent

2. CLI Usage (Local Indexing & Search)

DocsAgent provides a powerful CLI for managing your local knowledge base.

  • Index your folders:
    # Add one or more directories or files to the index
    docsagent add ~/Documents/Legal_Archive ~/Documents/Research
  • Search your documents:
    # Perform a semantic search directly from the terminal
    docsagent search "What are the key terms in the Barclays contract?"

3. MCP Usage (Connect to AI Agents)

DocsAgent is a native Model Context Protocol (MCP) server. This allows AI agents to "see" your local documents.

Start the MCP server:

docsagent server

πŸ”Œ Agent Integration Examples

Connect DocsAgent to your favorite tools using the following configurations:

OpenClaw (Recommended)

OpenClaw is the most powerful UI for local-first agents. Add DocsAgent in your config.yaml:

mcpServers:
  docsagent:
    command: "docsagent"
    args: ["server"]

Claude Code

Integrate with Anthropic's CLI tool:

claude code mcp add docsagent -- docsagent server

Cursor / Windsurf

  1. Open Settings > Features > MCP Servers.
  2. Click + Add New MCP Server.
  3. Name: DocsAgent
  4. Type: command
  5. Command: docsagent server

πŸ› οΈ Agent Tools (via MCP)

Once integrated, your AI agent gains professional-grade document capabilities through these tools:

  • search: Perform deep semantic search across your entire local library to find relevant snippets.
  • add_docs: Instantly index new local folders or files during a conversation.
  • (More tools coming soon: list_documents, remove_document, status)

πŸ’» CLI Reference

DocsAgent provides a powerful CLI with convenient aliases (dag, da):

Command Alias Example Description
server da server Start the MCP server service
add dag add <path> Add directories or files to the index
search da search "query" Search for documents directly from CLI
status dag status Check engine and indexing status
stop da stop Stop the background engine service

πŸ“‚ Support Matrix

Format Status Features
PDF βœ… Full Deep layout analysis & high-speed parsing
Word (.docx) βœ… Full Table extraction & heading hierarchy preserved
PPTX βœ… Full Extracts slides, shapes, and speaker notes

🀝 Community & Contributing

We are building the open standard for Local RAG. Join us in making AI respect personal data sovereignty!

  • GitHub Issues: Found a bug? Have a feature request? Open an issue.
  • Star the Repo: If DocsAgent improved your workflow, please give us a ⭐ to help others find the project!

βš–οΈ License

DocsAgent is open-source under the Apache-2.0 License.


Desktop Sovereignty is here. Empower your Agents with DocsAgent.

Popular repositories Loading

  1. docsagent docsagent Public

    DocsAgent is a local-first AI documents assistant that lets you securely index and chat with thousands of desktop documents with zero cloud leakage.

    TypeScript 294 5

  2. papersgpt-for-zotero papersgpt-for-zotero Public

    Forked from papersgpt/papersgpt-for-zotero

    Zotero GPT plugin chatting pdf with GPT, Claude, Gemini

    JavaScript

  3. hermes-agent hermes-agent Public

    Forked from NousResearch/hermes-agent

    The agent that grows with you

    Python