Docs MCP

🚀 Docs MCP Server

This project offers a flexible Model Context Protocol (MCP) server, powered by Probe. It enables AI assistants to search through documentation or codebases. You can interact with code or documentation simply by specifying a git repository or a folder.

🚀 Quick Start

To quickly start using the server, you can run the following command:

npx -y @buger/docs-mcp@latest --gitUrl https://github.com/buger/probe

✨ Features

• Powered by Probe: Utilizes the Probe search engine to deliver efficient and relevant results.
• Flexible Content Sources: You can include a specific local directory or clone a Git repository.
• Pre-build Content: Optionally, you can bundle documentation or code content directly into the package.
• Dynamic Configuration: Configure content sources, Git settings, and MCP tool details through a config file, CLI arguments, or environment variables.
• Automatic Git Updates: Keep your content up - to - date by automatically pulling changes from a Git repository at a configurable interval.
• Customizable MCP Tool: Define the name and description of the search tool presented to AI assistants.
• AI Integration: Seamlessly integrates with AI assistants that support the Model Context Protocol (MCP).

📦 Installation

Installing via Smithery

To install the Docs MCP Server for Claude Desktop automatically via Smithery, use the following command:

npx -y @smithery/cli install @buger/docs-mcp --client claude

💻 Usage Examples

Basic Usage

You can chat with code or your docs by pointing to a git repo or a folder. For example:

npx -y @buger/docs-mcp@latest --gitUrl https://github.com/buger/probe

Advanced Usage

Chat with any GitHub Repository

Point the server to a public or private Git repository to enable natural language queries about its contents. For example, to search the Tyk documentation repository:

{
  "mcpServers": {
    "tyk-docs-search": {
      "command": "npx",
      "args": [
        "-y",
        "@buger/docs-mcp@latest",
        "--gitUrl",
        "https://github.com/TykTechnologies/tyk-docs",
        "--toolName",
        "search_tyk_docs",
        "--toolDescription",
        "Search Tyk API Management Documentation"
      ],
      "enabled": true
    }
  }
}

Or you can use the following command directly:

npx -y @buger/docs-mcp@latest --gitUrl https://github.com/TykTechnologies/tyk-docs --toolName search_tyk_docs --toolDescription "Search Tyk API Management Documentation"

Using a Pre - built, Branded MCP Server

If a team publishes a pre - built package containing specific documentation (like @tyk-technologies/docs-mcp), the configuration is simpler:

{
  "mcpServers": {
    "tyk-official-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@tyk-technologies/docs-mcp@latest"
      ],
      "enabled": true
    }
  }
}

📚 Documentation

Configuration

Create a docs-mcp.config.json file in the root directory to define the default content source and MCP tool details.

Example 1: Using a Local Directory

{
  "includeDir": "/Users/username/projects/my-project/docs",
  "toolName": "search_my_project_docs",
  "toolDescription": "Search the documentation for My Project.",
  "ignorePatterns": [
    "node_modules",
    ".git",
    "build",
    "*.log"
  ]
}

Example 2: Using a Git Repository

{
  "gitUrl": "https://github.com/your-org/your-codebase.git",
  "gitRef": "develop",
  "autoUpdateInterval": 15,
  "toolName": "search_codebase",
  "toolDescription": "Search the main company codebase.",
  "ignorePatterns": [
    "*.test.js",
    "dist/",
    "__snapshots__"
  ]
}

Configuration Options

Precedence:

1. Runtime Configuration (Highest): CLI arguments and Environment Variables override all other settings. CLI arguments take precedence over Environment Variables.
2. Build - time Configuration: Settings in docs-mcp.config.json define defaults used during npm run build and also serve as runtime defaults if not overridden.
3. Default Values (Lowest): Internal defaults are used if no configuration is provided.

Creating Your Own Pre - built MCP Server

1. Fork/Clone this Repository: Start with this project's code.
2. Configure docs-mcp.config.json: Define the includeDir or gitUrl pointing to your content source. Set the default toolName and toolDescription.
3. Update package.json: Change the name, version, description, etc.
4. Build: Run npm run build.
5. Publish: Run npm publish (you'll need npm authentication configured).

Using with AI Assistants

This MCP server exposes a search tool to connected AI assistants via the Model Context Protocol.

Tool Parameters

• query: A natural language query or keywords describing what to search for (Required).
• page: The page number for results when dealing with many matches. Defaults to 1 if omitted (Optional).

Example Tool Call

{
  "tool_name": "search_tyk_docs",
  "arguments": {
    "query": "gateway rate limiting",
    "page": 1
  }
}

📄 License

This project is licensed under the MIT license.