MkDocs Search MCP server

This tool is an MCP (Model Context Protocol) server that allows you to search any MkDocs-powered documentation site. It integrates with LLMs like Claude and leverages the existing MkDocs search functionality through Lunr.js to provide relevant documentation search results.

Installation

You can install and use the MkDocs MCP server using npm or npx. No permanent installation is needed if you use npx.

Using npx (Recommended)

The easiest way to use this tool is with npx, which runs it without requiring a permanent installation:

npx -y @serverless-dna/mkdocs-mcp https://your-doc-site "Description of what you're searching for"

Manual Installation

If you prefer to install the package permanently:

# Install using npm
npm install @serverless-dna/mkdocs-mcp

# Or using pnpm
pnpm install @serverless-dna/mkdocs-mcp

# Build the project if installing from source
pnpm build

Configuration for Claude Desktop

To use with Claude Desktop, you'll need to configure it in your MCP configuration file:

1. Follow the Model Context Protocol Quickstart for Claude Desktop users
2. Add the following section to your MCP configuration file:

{
  "mcpServers": {
    "my-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@serverless-dna/mkdocs-mcp",
        "https://your-doc-site",
        "Describe what you are enabling search for to help your AI Agent"
      ]
    }
  }
}

Replace https://your-doc-site with the URL of your MkDocs site, and provide a helpful description.

Usage

Once configured, you can use the MCP server to search documentation through your LLM interface. The server provides a search_docs tool with the following parameters:

Search Parameters

• search: The search query string
• version: Optional version string (defaults to 'latest')

How the Search Works

The MCP server:

1. Loads pre-built Lunr.js indexes for the documentation site
2. Processes search queries against these indexes
3. Returns relevant documentation pages and content
4. Allows the LLM to summarize and present this information to you

This enables your AI assistant to provide more accurate and contextual information from your documentation site without needing to browse the web.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "mkdocs-mcp" '{"command":"npx","args":["-y","@serverless-dna/mkdocs-mcp","https://your-doc-site","Describe what you are enabling search for to help your AI Agent"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "mkdocs-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "@serverless-dna/mkdocs-mcp",
                "https://your-doc-site",
                "Describe what you are enabling search for to help your AI Agent"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your 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 this to your configuration file:

{
    "mcpServers": {
        "mkdocs-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "@serverless-dna/mkdocs-mcp",
                "https://your-doc-site",
                "Describe what you are enabling search for to help your AI Agent"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect