Markdown Documentation Sidecar

🚀 Markdown Sidecar MCP Server

This project offers a structured approach to serve and access Markdown documentation for NPM packages, Go modules, or PyPi packages via an MCP server. It enhances code generation intelligence by exposing these Markdown files as resources or tools.

⚠️ Important Note

Many PyPi packages do not make their Markdown documentation publicly available. Therefore, this library also mounts the root help documentation for Python by default.

This project is designed to be executed in the main directory of a project where the requested packages are already installed. Access is always restricted to your current working directory.

🚀 Quick Start

📦 Installation

npx -y markdown-sidecar-mcp

⚙️ Parameters

🖱️ Cursor 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"
      ]
    }
  }
}

💻 Development

# Install dependencies
npm i

# Build
npm run build

# Run with Bun
npm run build:mcp

🤝 Contribution Guidelines

1. Fork the repository.
2. Create your feature branch.
3. Commit your changes and push to the remote repository.
4. Submit a pull request.

📄 License

This project is released under the MIT License. See the LICENSE file for details.