MCP Documentation Service

The MCP Documentation Service is a custom implementation of the Model Context Protocol that allows AI assistants to interact with documentation. This service enables the creation, reading, updating, and deletion of documentation files, as well as searching and analyzing the documentation.

Features

Document Management: Create, read, update, and delete markdown documentation files
Metadata Management: Work with document frontmatter (YAML metadata)
Search: Search through documentation using keywords and filters
Analytics: Analyze documentation health and get suggestions for improvement
Custom Directory Support: Specify a custom docs directory and create it if it doesn't exist

Installation

Via npx (Recommended)

The easiest way to use MCP Documentation Service is through npx:

# Use default docs directory (./docs)
npx mcp-docs-service

# Specify a custom docs directory
npx mcp-docs-service --docs-dir ./my-custom-docs

# Create the directory if it doesn't exist
npx mcp-docs-service --docs-dir ./my-custom-docs --create-dir

# Show help
npx mcp-docs-service --help

Global Installation

You can also install it globally:

npm install -g mcp-docs-service

# Then use it with the same options as npx
mcp-docs-service --docs-dir ./my-custom-docs --create-dir

Local Installation

If you prefer to install it locally in your project:

npm install mcp-docs-service

Command-Line Options

The MCP Documentation Service supports the following command-line options:

--docs-dir <path>: Specify the docs directory (default: ./docs)
--create-dir: Create the docs directory if it doesn't exist
--help, -h: Show help message

Integration

With Cursor IDE

Add this to your .cursor/mcp.json file:

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": ["-y", "mcp-docs-service"]
    }
  }
}

To specify a custom docs directory:

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-docs-service",
        "--docs-dir",
        "./my-custom-docs",
        "--create-dir"
      ]
    }
  }
}

With Claude Desktop

Add this to your claude_desktop_config.json file:

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": ["-y", "mcp-docs-service"]
    }
  }
}

To specify a custom docs directory:

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-docs-service",
        "--docs-dir",
        "./my-custom-docs",
        "--create-dir"
      ]
    }
  }
}

Programmatic Usage

You can also use MCP Documentation Service programmatically in your Node.js application:

const { MCPDocsServer } = require("mcp-docs-service");

// Create a new MCP server instance with default docs directory
const server = new MCPDocsServer("./docs");

// Or with a custom docs directory
const customServer = new MCPDocsServer("./my-custom-docs", {
  createIfNotExists: true, // Create the directory if it doesn't exist
  fileExtensions: [".md", ".mdx"], // Specify file extensions to consider (optional)
});

// Execute a query
async function example() {
  try {
    const result = await server.executeQuery("list_files");
    console.log(result);
  } catch (error) {
    console.error(error);
  }
}

example();

You can also use the query function directly:

const { query } = require("mcp-docs-service");

// Execute a query with a custom docs directory
async function example() {
  try {
    const result = await query("list_files", {
      docsDir: "./my-custom-docs",
      createIfNotExists: true,
    });
    console.log(result);
  } catch (error) {
    console.error(error);
  }
}

example();

Query Format

The service uses a SQL-like query format to execute commands:

command_name(param1="value1", param2="value2")

For example:

get_document(path="architecture/overview.md")

Available Commands

Document Operations

list_files(directory=""): List all markdown files (optionally in a specific directory)
list_directories(directory=""): List all directories (optionally in a specific directory)
get_document(path="path/to/doc.md"): Get a document's content and metadata
create_document(path="path/to/doc.md", content="content", metadata={...}): Create a new document
update_document(path="path/to/doc.md", content="updated content", metadata={...}): Update an existing document
delete_document(path="path/to/doc.md"): Delete a document

Search & Analysis

search_documents(query="search term", directory="", tags=["tag1"], status="published"): Search documents
analyze_docs(directory=""): Analyze documentation health
get_health_score(): Get overall documentation health score
get_suggestions(): Get suggestions for improving documentation

License

MIT