Open Docs

An open-source MCP implementation providing document management functionality

javascript

17

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You run open-docs-mcp to crawl, index, and search your documentation sources from a single MCP server. It lets you manage multiple docs, build a searchable index, and access documents through MCP-style resources and tools, enabling AI-assisted context across your docs.

How to use

You connect to the open-docs-mcp server from your MCP client to enable, crawl, index, and search your documentation. Use the client to enable_doc for each source, crawl_docs to refresh content, and search_docs to locate information across all indexed docs. You can list enabled docs with list_enabled_docs and see all available docs with list_all_docs. When you need to scale your search index, run build_index to ensure full-text search stays up to date. Tools expose practical capabilities for managing documentation without leaving your MCP environment.

How to install

Prerequisites: have Node.js and npm installed on your machine. You also need a compatible MCP client to interact with the server.

Install and run the server locally using the standard MCP command:

npx -y open-docs-mcp --docsDir ./docs

## Configuration

To use the server with a Claude Desktop client, add a server entry to your Claude configuration with the following example. It runs the MCP server locally via npx and passes the docs directory path.

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

## Security and maintenance notes

Keep your docs directory secure and ensure only trusted sources are crawled. Regularly re-build the index after adding new documents to keep search results fresh. Use the alwaysAllow setting to restrict tool usage when needed.

## Available tools

### enable\_doc

Enable crawling for a specific document source.

### disable\_doc

Disable crawling for a specific document source.

### crawl\_docs

Start crawling enabled documents to refresh the content you can search.

### build\_index

Build or rebuild the full-text search index for all indexed documents.

### search\_docs

Search across the indexed documentation using the built index.

### list\_enabled\_docs

List all documentation sources that are currently enabled for crawling.

### list\_all\_docs

List all available documentation sources that can be enabled.