
Markdown Sidecar MCP Server
from lwsinclair
Serve and access markdown documentation for locally installed NPM, Go, or PyPi packages.
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]
Note: Many PyPi packages do not have markdown docs exposed, so this library will also mount pythonhelproot 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.
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.
Development
# Install dependencies
npm i
# Build
npm run build
# Run with Bun
npm run build:mcpnpx -y markdown-sidecar-mcpInstallation
npx -y markdown-sidecar-mcpCursor Installation Steps
Add the following server definition to your .cursor/mcp.json file:
{
"mcpServers": {
"sidecar": {
"command": "npx",
"args": [
"-y", "--package", "markdown-sidecar-mcp",
"--",
"mcp", "start",
"--workingDir", "{REPO_WORKING_DIR}",
"--packageName", "{PACKAGE_NAME}",
"--registry", "npm"
]
}
}
}No common issues documented yet. If you hit a problem, the repository's GitHub Issues page is the best place to look.
Licensed under MITโ you can use, modify, and redistribute it under that license's terms.
License
This project is licensed under the MIT License - see the LICENSE file for details.