Documentation Manager

🚀 MCP Documentation

MCP Documentation Service is a tool designed to manage and process documentation files. It offers a range of features, including reading, writing, and listing documents, as well as generating indexes and statistical reports.

🚀 Quick Start

Basic Usage

Place all your documentation files in the docs directory and run the following command in your terminal:

npx mcp-docs-service docs

Advanced Options

• Specify the output directory:

  npx mcp-docs-service --output-dir output docs
  

• Set the log level:

  npx mcp-docs-service --log-level debug docs
  

📦 Installation

To start using the MCP Documentation Service, follow these steps:

1. Install dependencies:

   npm install mcp-docs-service
   

2. Run the service:

   npx mcp-docs-service /path/to/docs
   

💻 Usage Examples

Basic Examples

# Generate a documentation index file
npx mcp-docs-service --index docs index.html

# Specify the output format as JSON
npx mcp-docs-service --format json docs output.json

Advanced Examples

# Scan the entire documentation directory and output statistical information
npx mcp-docs-service --scan docs stats.json

# Use a custom configuration file
npx mcp-docs-service --config config.json docs

📚 Documentation

MCP Documentation Protocol

The MCP Documentation Service is a file system-based protocol that supports the following operations:

Operation Types

1. Read document content

   {
     "action": "read",
     "path": "/docs/example.md"
   }
   

2. Write document content

   {
     "action": "write",
     "content": "## New Document\nThis is a new Markdown document.",
     "path": "/docs/new.md"
   }
   

3. List all documents

   {
     "action": "list",
     "dir": "/docs"
   }
   

Response Format

Each operation's response includes a status field, which can have the following values:

• "success": The operation is completed.
• "error": An error has occurred.

Configuration Options

The MCP Documentation Service supports the following configuration options:

Basic Configuration

• --output-dir: Specify the output directory. The default is the current directory.
• --log-level: Set the log level. Available values are debug, info, warning, error.

Advanced Configuration

• --scan: Enable the document scanning function to generate a statistical report.
• --index: Generate a documentation index file.
• --format: Specify the output format, supporting markdown and json.

Tool Reference

The MCP Documentation Service provides the following tools:

1. Document Scanner

# Scan the documentation directory and generate a statistical report
npx mcp-docs-service --scan docs report.json

2. Index Generator

# Generate a documentation index file
npx mcp-docs-service --index docs index.html

Troubleshooting

Common Issues

• Problem: The documentation directory cannot be found.

• Solution: Check if the path is correct or use an absolute path.

• Problem: The scanning function does not work.

• Solution: Ensure that you have installed the latest version of the MCP Documentation Service and rerun the command.

Detailed Documentation

For more information about the MCP Documentation Service, please refer to the following links:

• Getting Started Guide
• MCP Integration Guide
• MCP Protocol Usage Instructions
• Tool Reference Documentation

📄 License

The MCP Documentation Service is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

⚠️ Important Note

The above content is a brief introduction to the MCP Documentation Service. For more advanced features and configuration options, please refer to the project documentation.