read-docs-mcp
by ZebraRoy
A Model Control Protocol (MCP) server that enables AI agents to access and understand package documentation through a structured interface. It supports two modes: reading existing documentation and creating a documentation structure.
Last updated: N/A
What is read-docs-mcp?
read-docs-mcp is an MCP server designed to help AI agents understand and access package documentation. It can function as a document reader for existing repositories or as a guide for creating a structured documentation setup.
How to use read-docs-mcp?
The server can be used in two modes: Read Documentation Mode (with --name and --git-repo-path) to access documentation from a repository, and Create Documentation Mode (without repository information) to get instructions on setting up documentation. Configuration is done via command-line arguments. Example configurations for Cursor are provided in the README.
Key features of read-docs-mcp
Automatically generates MCP tools from documentation structure
Supports multiple documentation modules (hooks, components, utilities, etc.)
Configurable naming patterns for documentation files and module folders
Provides listing, overview, and detailed documentation access
Dynamic tool generation based on configured modules
Fallback to package.json for version information
Use cases of read-docs-mcp
Allowing AI agents to understand and use a library by reading its documentation
Guiding developers in creating a structured documentation for their libraries
Providing a standardized way to access documentation across different libraries
Automating the process of generating documentation-related tools for AI agents
FAQ from read-docs-mcp
What is Read Documentation Mode?
What is Read Documentation Mode?
This mode allows AI agents to read and understand documentation from a specified repository.
What is Create Documentation Mode?
What is Create Documentation Mode?
This mode provides instructions and guidance on how to create a structured documentation setup for a library.
What command-line arguments are supported?
What command-line arguments are supported?
The server supports arguments like --name, --git-repo-path, --branch, --docs-path, and --clone-location.
How does Git authentication work?
How does Git authentication work?
The MCP requires direct cloning of the target Git repository, so you need to ensure proper access with SSH keys or personal access tokens.
How do I configure the server in Cursor?
How do I configure the server in Cursor?
Add the appropriate configuration snippets provided in the README to your Cursor settings, depending on the usage mode and operating system.