Provides a structured way to serve and access markdown documentation from local project packages as MCP resources or tools to inform code generation.
Enables access to markdown documentation for locally installed npm packages, exposing them as MCP primitives for informed development.
Enables access to markdown documentation for locally installed PyPI packages, allowing them to be used as tools or resources.
Automatically mounts Python help root documentation for PyPI packages that do not have exposed markdown documentation.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Markdown Sidecar MCP Serverget the documentation for the express npm package"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Markdown Sidecar MCP Server
This provides a structured way to serve and access markdown documentation from an MCP server for NPM packages, Go Modules, or PyPi packages. It enables informed code generation by exposing these markdown files as resources or tools.
Note: Many PyPi packages do not have markdown docs exposed, so this library will also mount python help root docs by default.
This is designed to be executed from within a project directory where the requested packages are already installed locally. Access always stays within your local environments working directory.
Installation
Arguments
workingDir: The working directory of your repo.packageName: The name of the package or module to requestregistry: Registry the package will be found in (npm,gomodules, orpypi)docsSubDir: [OPTIONAL] The specific subdirectory to look for markdown docs in. Defaults to package root.mcpPrimitive: [OPTIONAL] The MCP primitive to expose from the server (toolorresource). This defaults totool, some clients do not currently support resources.
Cursor Installation Steps
Add the following server definition to your .cursor/mcp.json file:
Development
Contributing
Fork the repository
Create your feature branch
Commit your changes and push them up
Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.