Read Docs

Provides an MCP interface to read and navigate package documentation with modular access, overview, lists, details, and optional source viewing.

javascript

5

GitHub Stars

javascript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "zebraroy-read-docs-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "read-docs-mcp",
        "--git-repo-path=https://github.com/user/repo",
        "--name=YourLibName"
      ]
    }
  }
}

You can run a dedicated MCP server to read and explore package documentation through a structured, tool-based interface. It automatically generates accessible tools from your documentation layout, letting you list, overview, and dive into specific items like hooks, components, utilities, and more. This makes it easy to navigate complex docs with fast, precise queries.

How to use

Use the MCP server with your client to explore documentation in a guided, interactive way. Start by provisioning a read-only view of the modules you care about, then request fast access to module overviews, item lists, and item details. You’ll also be able to perform fuzzy searches to locate relevant docs by keyword and, if enabled, read source files for deeper understanding.

How to install

Prerequisites: you need Node.js installed on your machine. You also need access to the target repository if you plan to read documentation from a remote source.

Step 1: Install the MCP client globally or run via npx. Step 2: Start the MCP server with the appropriate command. Step 3: Point your MCP client to the server and begin querying the documentation.

If you are using a repository, you will clone or fetch the repository as part of setup, then start the server to expose the generated tools for documentation access.

Key commands you’ll use include running the MCP with the read-docs-mcp entry point and providing your repository details when needed.

Configuration and usage notes

Two main usage modes exist. When you provide a repository path and a name, you can read documentation from that repository and generate access tools for the docs. If you do not provide repository information, you’ll receive guidance for creating a documentation structure.

Security and authentication are important if you access private repos. Use a personal access token or SSH keys as appropriate to enable cloning. The server supports both HTTPS and SSH URLs depending on your hosting provider.

You can customize docs location, module naming patterns, and which modules to include. You can also enable an optional source-reading tool to inspect implementation details directly from the repository.

Examples of how the server can be started

Start in a typical Unix-like environment using the following pattern to read from a public repo and name your library.

%npx -y read-docs-mcp --name=YourLibName --git-repo-path=https://github.com/user/repo

If you are on Windows and prefer using a CMD shell, you can start with a similar configuration tailored for Windows.

`cmd
npx -y read-docs-mcp --name=YourLibName --git-repo-path=https://github.com/user/repo

Available tools

read-docs-mcp-get-hooks-list

Get a list of hooks in the docs module Hooks by returning the contents of the list file (default: list.md) for the hooks module.

read-docs-mcp-get-hooks-details

Get details for a specific hook in the hooks module. Returns the contents of the details document named according to the naming pattern (e.g., kebab-case file).

read-docs-mcp-get-hooks-overview

Get an overview of the hooks module by returning the contents of the overview file (default: overview.md).

read-docs-mcp-fuzzy-search

Search documentation files by a keyword with prioritized results: exact filename, partial filename, exact content, then partial content.

read-docs-mcp-get-components-list

Get a list of components from the components module by returning the list file contents.

read-docs-mcp-get-components-details

Get details for a specific component from the components module.

read-docs-mcp-get-components-overview

Get an overview of the components module by returning its overview contents.

read-docs-mcp-get-overview

Get an overall project overview in two-step mode or when requested, consolidating module information.

read-docs-mcp-get-overall-list

List all available documentation modules.

read-docs-mcp-get-module-overview

Get an overview for a specific module by name.

read-docs-mcp-get-module-list

List all items within a specific module.

read-docs-mcp-get-module-detail

Get details for a specific item within a module.

read-docs-mcp-read-source-file

Read the contents of a source file from the repository when inclusion of source is enabled.