Open Docs MCP

🚀 open-docs-mcp Documentation Server

An open-source MCP implementation that provides document management functionality.

[Chinese Documentation][url-doczh]

🚀 Quick Start

To run the open-docs-mcp server, you can use the following command:

npm start

✨ Features

Document Management

• Crawl and index documents from multiple sources.
• Support multiple document formats.
• Provide full-text search functionality.

MCP Server API

• Resource-based document access.
• Tool-oriented document management.

Available Tools

1. enable_doc - Enable crawling of specific documents.
2. disable_doc - Disable crawling of specific documents.
3. crawl_docs - Start crawling enabled documents.
4. build_index - Build the document search index.
5. search_docs - Search document content.
6. list_enabled_docs - List enabled documents.
7. list_all_docs - List all available documents.

Compatibility with Cursor @Docs

This project aims to simulate Cursor's @Docs functionality by providing the following features:

1. Document Indexing:

   • Crawl and index documents from multiple sources.
   • Support multiple document formats (HTML, Markdown, etc.).
   • Automatically re-index to keep documents up-to-date.

2. Document Access:

   • Search across all indexed documents.
   • Integrate the MCP protocol for AI context.

3. Custom Document Management:

   • Add new document sources via the enable_doc tool.
   • Manage enabled documents using the list_enabled_docs tool.
   • Force re-crawling using the crawl_docs tool.

Architecture

┌───────────────────────────────────────────────────────┐
│                    open-docs-mcp Server                    │
├───────────────────┬───────────────────┬───────────────┤
│   Crawler Module  │  Search Engine    │  MCP Server   │
├───────────────────┼───────────────────┼───────────────┤
│ - Web crawling    │ - Full-text indexing │ - Document management │
│ - Document storage │                  │              │
└───────────────────┴───────────────────┴───────────────┘

📦 Installation

Installation Steps

1. Clone the repository: git clone https://github.com/your-repository.git
2. Navigate to the directory: cd open-docs-mcp
3. Install dependencies: npm install

Configuration File

You can create a config.json file to configure the server:

{
  "port": 3000,
  "documentRoot": "./documents"
}

💻 Usage Examples

Basic Usage

To start the server, run:

npm start

Advanced Usage

Development

To start development, you can run the following commands:

• Monitor file changes: npm run watch
• Start debug mode: npm run debug

🤝 Contribution Guidelines

We welcome contributions from the community! Please refer to CONTRIBUTING.md in the project repository to learn how to participate.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.