get-create-docs-instructions
Get instructions to create a new document
LABSCO SUMMARY
It reads documentation you have structured for it. It does not write that documentation.
Pointed at a repository, it clones it and builds tools from the docs folder, so the assistant reads your library's own documentation instead of guessing. That folder follows a set layout, a read-docs-mcp.json plus one folder per module, and run without a repository the server returns the instructions for building it.
What it is
A documentation reader for one git repository. Started with --name and --git-repo-path, it clones the repository and generates tools from its docs folder; started without them, it offers one tool that explains the folder layout it expects.
What you get
- Tools prefixed with your --name that list, overview and read the items in each docs module, plus a fuzzy search across the documentation files.
Requirements
Nothing — no account, no key.
Setup effort
One command — npx -y read-docs-mcp --name=<YOUR_LIBRARY_NAME> --git-repo-path=<YOUR_GIT_REPO_PATH>
USE CASES
01
Answering a question from a library's own documentation
Search the repository's docs, open the module overview it points to, and answer from what the library's authors wrote rather than from memory.
1 tool
Counted once with only startup setup. Other versions, modes or optional credentials may expose a different list.
BEFORE YOU INSTALL
What to know first
Tools you get
1 tool when we connected; the project documents 11. Without --name or --git-repo-path the server runs in Create Documentation Mode with only get-create-docs-instructions. In Read Documentation Mode tools are generated per module, prefixed with the package name, and {name}-read-source-file needs --include-src=true.
Requires
- npx on PATH
- Access to the git repository you point it at (it clones it)
Where it runs
Both documented setups run the server on your machine.
INSTALLATION
Connect your client
Server setup
TERMINAL
npx -y read-docs-mcp --name=<YOUR_LIBRARY_NAME> --git-repo-path=<YOUR_GIT_REPO_PATH>MCP Clients
Cursor — macOS or Linux
CURSOR — MACOS OR LINUX · JSON
{
"mcpServers": {
"<YOUR_LIBRARY_NAME>": {
"command": "npx",
"args": [
"-y",
"read-docs-mcp",
"--git-repo-path=<YOUR_GIT_REPO_PATH>",
"--name=<YOUR_LIBRARY_NAME>"
]
}
}
}Cursor — Windows
CURSOR — WINDOWS · JSON
{
"mcpServers": {
"<YOUR_LIBRARY_NAME>": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"read-docs-mcp",
"--git-repo-path=<YOUR_GIT_REPO_PATH>",
"--name=<YOUR_LIBRARY_NAME>"
]
}
}
}
