Skip to main content
Glama

documcp

by tosin2013
npmGitHub
TypeScript
MIT License
12
2
  • Apple
  • Linux
OverviewInspectNewEndpointsSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

DocuMCP - Intelligent Documentation Deployment MCP Server

DocuMCP is an intelligent Model Context Protocol (MCP) server that revolutionizes documentation deployment for open-source projects. It provides deep repository analysis, intelligent static site generator recommendations, and automated GitHub Pages deployment workflows.

Features

  • 🔍 Repository Analysis: Deep multi-layered analysis of project structure, dependencies, and documentation needs
  • 🎯 SSG Recommendations: Data-driven recommendations for Jekyll, Hugo, Docusaurus, MkDocs, or Eleventy
  • 📚 Diataxis Framework: Automatic creation of well-structured documentation following proven principles
  • 🚀 GitHub Pages Deployment: Automated workflow generation with SSG-specific optimizations
  • ✅ Deployment Verification: Comprehensive checks and troubleshooting for successful deployments

Requirements

  • Node.js: 20.0.0 or higher
  • npm: Latest stable version

Installation

# Clone the repository git clone https://github.com/tosin2013/documcp.git cd documcp # Install dependencies npm install # Build the project npm run build

MCP Client Setup

DocuMCP works with various MCP-enabled clients. Here's how to configure it:

Claude Desktop

  1. Locate Claude Desktop's configuration file:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
    • Linux: ~/.config/claude/claude_desktop_config.json
  2. Add documcp server configuration:
    { "mcpServers": { "documcp": { "command": "npx", "args": ["documcp"] } } }
  3. Restart Claude Desktop to load the configuration.

VS Code with GitHub Copilot

  1. Install MCP extension for VS Code
  2. Configure in VS Code settings.json:
    { "mcp.servers": { "documcp": { "command": "npx", "args": ["documcp"] } } }

Cursor Editor

  1. Configure in Cursor settings:
    { "mcpServers": { "documcp": { "command": "npx", "args": ["documcp"] } } }

Gemini Code Assist

  1. Check Gemini documentation for MCP server configuration
  2. Add similar configuration as above

Troubleshooting

  • Ensure npx is available in your PATH
  • For global installations, use the full path:
    { "command": "node", "args": ["/usr/local/lib/node_modules/documcp/dist/index.js"] }
  • Find installation path: npm list -g documcp

Usage

Once configured with your MCP client, DocuMCP provides eleven comprehensive MCP tools:

1. Analyze Repository

Performs deep analysis of your project to understand its characteristics and documentation needs.

{ "tool": "analyze_repository", "arguments": { "path": "/path/to/your/repo", "depth": "standard" } }

2. Recommend SSG

Provides intelligent recommendations for the best static site generator based on your project.

{ "tool": "recommend_ssg", "arguments": { "analysisId": "analysis_12345", "preferences": { "priority": "simplicity" } } }

3. Generate Config

Creates all necessary configuration files for your chosen static site generator.

{ "tool": "generate_config", "arguments": { "ssg": "docusaurus", "projectName": "My Project", "outputPath": "./docs" } }

4. Setup Structure

Creates a Diataxis-compliant documentation structure with proper categorization.

{ "tool": "setup_structure", "arguments": { "path": "./docs", "ssg": "docusaurus", "includeExamples": true } }

5. Deploy Pages

Sets up GitHub Actions workflows for automated deployment to GitHub Pages.

{ "tool": "deploy_pages", "arguments": { "repository": ".", "ssg": "docusaurus", "branch": "gh-pages" } }

6. Verify Deployment

Checks your setup and provides troubleshooting guidance for successful deployment.

{ "tool": "verify_deployment", "arguments": { "repository": ".", "url": "https://yourusername.github.io/yourproject" } }

7. Populate Diataxis Content

Intelligently populates documentation with project-specific content.

{ "tool": "populate_diataxis_content", "arguments": { "analysisId": "analysis_12345", "docsPath": "./docs", "populationLevel": "comprehensive" } }

8. Validate Diataxis Content

Validates accuracy, completeness, and compliance of documentation.

{ "tool": "validate_diataxis_content", "arguments": { "contentPath": "./docs", "validationType": "all" } }

9. Validate Content

Checks general content quality including links and code syntax.

{ "tool": "validate_content", "arguments": { "contentPath": "./docs", "validationType": "links" } }

10. Detect Documentation Gaps

Analyzes repository to identify missing documentation content.

{ "tool": "detect_documentation_gaps", "arguments": { "repositoryPath": ".", "documentationPath": "./docs" } }

11. Test Local Deployment

Tests documentation build and local server before deployment.

{ "tool": "test_local_deployment", "arguments": { "repositoryPath": ".", "ssg": "docusaurus", "port": 3000 } }

Development

# Run in development mode npm run dev # Run tests npm test # Lint code npm run lint # Type check npm run typecheck

Architecture

DocuMCP follows a modular, stateless architecture:

  • TypeScript-based implementation using the official MCP SDK
  • Stateless operation for consistency and reliability
  • Modular design with clear separation of concerns
  • Progressive complexity allowing users to start simple

Documentation Structure (Diataxis)

DocuMCP automatically creates documentation following the Diataxis framework:

  • Tutorials: Learning-oriented guides for newcomers
  • How-To Guides: Task-oriented recipes for specific goals
  • Reference: Information-oriented technical descriptions
  • Explanation: Understanding-oriented conceptual discussions

Contributing

We welcome contributions! Please see our Contributing Guide for details.

First Time Contributors

Look for issues labeled "good first issue" to get started with the project. We welcome contributions from developers of all experience levels.

Reporting Issues

Please use our issue templates when reporting bugs or requesting features.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

Security

Please see our Security Policy for reporting vulnerabilities and security-related issues.

License

MIT License - see LICENSE for details.

Acknowledgments

Deploy Server
-
security - not tested
A
license - permissive license
-
quality - not tested

How are these scores calculated?

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Tools

View all tools

DocuMCP is an intelligent Model Context Protocol (MCP) server that revolutionizes documentation deployment for open-source projects. It provides deep repository analysis, intelligent static site generator recommendations, and automated GitHub Pages deployment workflows.

  1. Features
    1. Requirements
      1. Installation
        1. MCP Client Setup
          1. Claude Desktop
          2. VS Code with GitHub Copilot
          3. Cursor Editor
          4. Gemini Code Assist
          5. Troubleshooting
        2. Usage
          1. 1. Analyze Repository
          2. 2. Recommend SSG
          3. 3. Generate Config
          4. 4. Setup Structure
          5. 5. Deploy Pages
          6. 6. Verify Deployment
          7. 7. Populate Diataxis Content
          8. 8. Validate Diataxis Content
          9. 9. Validate Content
          10. 10. Detect Documentation Gaps
          11. 11. Test Local Deployment
        3. Development
          1. Architecture
            1. Documentation Structure (Diataxis)
              1. Contributing
                1. First Time Contributors
                2. Reporting Issues
              2. Code of Conduct
                1. Security
                  1. License
                    1. Acknowledgments

                      Related MCP Servers

                      • godoc-mcp

                        mrjoshuak
                        -
                        security
                        A
                        license
                        -
                        quality
                        godoc-mcp is a Model Context Protocol (MCP) server that provides efficient access to Go documentation. It helps LLMs understand Go projects by providing direct access to package documentation without needing to read entire source files.
                        Last updated -
                        83
                        MIT License

                      • open-docs-mcp

                        askme765cs
                        A
                        security
                        F
                        license
                        A
                        quality
                        An open-source MCP implementation providing document management functionality. This project aims to replicate Cursor's @Docs functionality.
                        Last updated -
                        8
                        26
                        10
                        • Apple

                      • McpDocServer

                        ruan11223344
                        A
                        security
                        A
                        license
                        A
                        quality
                        A documentation server based on MCP protocol designed for various development frameworks that provides multi-threaded document crawling, local document loading, keyword searching, and document detail retrieval.
                        Last updated -
                        3
                        49
                        MIT License
                        • Apple
                        • Linux

                      • Memory Bank MCP

                        tuncer-byte
                        A
                        security
                        F
                        license
                        A
                        quality
                        An MCP server that helps teams create, manage, and access structured project documentation through six core document types, leveraging AI to generate comprehensive project knowledge management.
                        Last updated -
                        5
                        29
                        99

                      View all related MCP servers

                      New MCP Servers

                      MCP directory API

                      We provide all the information about MCP servers via our MCP API.

                      curl -X GET 'https://glama.ai/api/mcp/v1/servers/tosin2013/documcp'

                      If you have feedback or need assistance with the MCP directory API, please join our Discord server