Arabold Docs MCP Server

🚀 Docs-MCP

docs-mcp is a Model Context Protocol (MCP) server for managing and controlling documents, offering features like document storage, version control, and extensibility.

🚀 Quick Start

For detailed installation steps, please refer to INSTALL.md.

✨ Features

docs-mcp is a Model Context Protocol (MCP) server designed for document management and control. Here are its core features and usage methods:

1. Document Storage and Management

   • Documents are organized in a hierarchical structure and support multiple formats (e.g., Markdown, JSON).
   • Enable remote document interaction via the MCP protocol.

2. Version Control

   • Each document has a unique version number and change history.
   • Support a semantic version control system.

3. Extensibility

   • Provide a rich set of plugin interfaces for custom feature extensions.
   • Support integration with various tools and services (e.g., CI/CD, IDE).

💻 Usage Examples

Basic Usage

# Start the docs-mcp server
node dist/server.js --port 3000

# Use the document management functionality
curl -X POST http://localhost:3000/docs/create \
     -H "Content-Type: application/json" \
     -d '{"title": "My First Document", "content": "This is the content of my first document"}'

# View the document list
curl http://localhost:3000/docs/list

# Get a specific document
curl http://localhost:3000/docs/[doc_id]

# Update a document
curl -X PUT http://localhost:3000/docs/[doc_id] \
     -H "Content-Type: application/json" \
     -d '{"title": "Updated Title", "content": "This is the updated content"}'

# Delete a document
curl -X DELETE http://localhost:3000/docs/[doc_id]

Advanced Usage

Complete Command - Line Options

Here are the full command - line options available for docs-mcp:

• Start the Server

  node dist/server.js [--port <port>] [--env <environment>]
  

  • --port: Specify the port the server listens on, default is 3000.
  • --env: Specify the running environment (e.g., development, production), default is development.

• Document Management Commands

  npm run docs-mcp <command> [-- <args...>]
  
  Commands:
    create       Create a new document
    list         List all documents
    get          Get a specific document
    update       Update an existing document
    delete       Delete a document
  

Document Version Control

docs-mcp supports a semantic version control system. Each time a document is updated, a new version number is automatically generated, and the change history is recorded.

Extensions and Plugins

docs-mcp provides a rich set of plugin interfaces, allowing developers to extend functionality as needed. For example:

• Logging Plugin

  const { Logger } = require('@modelcontextprotocol/mcp-core').Logger;
  
  module.exports = {
    logger: new Logger({
      level: 'debug',
      handlers: [
        // Add custom log handlers
      ],
    }),
  };
  

• Authentication Plugin

  const { Auth } = require('@modelcontextprotocol/mcp-core').Auth;
  
  module.exports = {
    auth: new Auth({
      provider: 'custom',
      // Configure a custom authentication provider
    }),
  };
  

Example Projects

For more examples, please visit DOCS - MCP Examples.

📚 Documentation

Code Structure Overview

docs-mcp/
├── src/                 # Source code directory
│   ├── server.js       # Main server file
│   ├── commands/       # Command - line processing module
│   └── plugins/        # Plugin system implementation
├── dist/               # Compiled output directory
├── package.json        # Project dependencies and configuration
└── .env.example        # Example environment variable file

Quick Start for Development

# Clone the repository
git clone https://github.com/modelcontextprotocol/docs-mcp.git
cd docs-mcp

# Install dependencies
npm install

# Start the development server
npm run dev

# Compile the project
npm run build

Contribution Guide

If you want to contribute to docs-mcp, please refer to CONTRIBUTING.md.

📄 Support

If you encounter any issues, please visit DOCS - MCP Issue Tracking to submit feedback or ask questions.

⚠️ Important Note

This project is experimental and not fully stable yet. Please read the relevant documentation carefully and back up your data before use.