mcpField
O
Open Docs Mcp

Open Docs Mcp

Local
github.com/askme765csMemory & Knowledge18Updated 81w ago
Repository

About Open Docs Mcp

Open Docs Mcp is an open-source document management MCP server for teams and AI clients that need searchable documentation. It crawls and indexes sources, then exposes document search and management through resources and tools.

Key features

  1. 01Crawl and index documentation
  2. 02Support HTML and Markdown
  3. 03Full-text search with relevance scoring
  4. 04Manage enabled document sources
  5. 05Expose documents as resources

Use cases

  1. 01Search across indexed project documentation
  2. 02Add or disable documentation sources
  3. 03Refresh indexes after documentation changes

MCP support

The server exposes indexed documents as MCP resources and provides tools for enabling sources, crawling, indexing, searching, and listing documents.

#open-docs-mcp#document-management#mcp-server

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
  "mcpServers": {
    "open-docs": {
      "command": "npx",
      "args": [
        "-y",
        "open-docs-mcp"
      ]
    }
  }
}
Run commandnpx -y open-docs-mcp

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npmopen-docs-mcp

Tools

7

Saved tool list · updated 3w ago

ParameterTypeRequiredDescription
namestringYesName of the doc to enable

Details

From the project README

open-docs-mcp MCP Server

smithery badge License Node Version TypeScript

An open-source MCP implementation providing document management functionality. 中文文档

Features

Document Management
  • Crawl and index documentation from various sources
  • Support for multiple document formats
  • Full-text search capabilities
MCP Server API
  • Resource-based access to documents
  • Tool-based document management
Available Tools
  1. enable_doc - Enable crawling for a specific doc
  2. disable_doc - Disable crawling for a specific doc
  3. crawl_docs - Start crawling enabled docs
  4. build_index - Build search index for docs
  5. search_docs - Search documentation
  6. list_enabled_docs - List enabled docs
  7. list_all_docs - List all available docs
Cursor @Docs Compatibility

This project aims to replicate Cursor's @Docs functionality by providing:

  1. Document Indexing:

    • Crawl and index documentation from various sources
    • Support for multiple document formats (HTML, Markdown, etc.)
    • Automatic re-indexing to keep docs up-to-date

  2. Document Access:

    • Search across all indexed documentation
    • Integration with MCP protocol for AI context

  3. Custom Docs Management:

    • Add new documentation sources via enable_doc tool
    • Manage enabled docs via list_enabled_docs tool
    • Force re-crawl with crawl_docs tool
Architecture
┌───────────────────────────────────────────────────────┐
│                    open-docs-mcp Server                    │
├───────────────────┬───────────────────┬───────────────┤
│   Crawler Module  │  Search Engine    │  MCP Server   │
├───────────────────┼───────────────────┼───────────────┤
│ - Web crawling    │ - Full-text index │ - Resources   │
│ - Doc conversion  │ - Relevance score │ - Tools       │
│ - Storage         │ - Query parsing   │ - Prompts     │
└───────────────────┴───────────────────┴───────────────┘

Usage

npx -y open-docs-mcp --docsDir ./docs
Installing via Smithery

To install Document Management Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @askme765cs/open-docs-mcp --client claude
Configuration

To use with Claude Desktop, add the server config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "open-docs-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "open-docs-mcp",
        "--docsDir",
        "/path/to/docs"
      ]
    }
  }
}

Configuration Options:

  • command: Node.js executable
  • args: Array of arguments to pass to the script
    • --docsDir: Required, specifies docs directory path
  • disabled: Set to true to temporarily disable the server
  • alwaysAllow: Array of tool names that can be used without confirmation

Development

npm run watch  # Auto-rebuild on changes
npm run inspector  # Debug with MCP Inspector

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.