Markdown Sidecar MCP Server

Integrations

  • Serves markdown documentation files as resources or tools, providing structured access to documentation content for AI assistants

  • Enables access to markdown documentation from NPM packages, allowing AI agents to browse package documentation for better code generation

  • Provides structured access to markdown documentation and Python help docs from PyPI packages, enhancing AI understanding of Python libraries

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 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

npx -y markdown-sidecar-mcp

Arguments

  • workingDir: The working directory of your repo.
  • packageName: The name of the package or module to request
  • registry: Registry the package will be found in (npm, gomodules, or pypi)
  • 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 (tool or resource). This defaults to tool, some clients do not currently support resources.

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

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes and push them up
  4. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

-
security - not tested
A
license - permissive license
-
quality - not tested

A server that provides structured access to markdown documentation from NPM packages, Go Modules, or PyPi packages, enabling informed code generation by exposing these docs as resources or tools.

  1. Installation
    1. Arguments
      1. Cursor Installation Steps
        1. Development
          1. Contributing
            1. License
              ID: 2wznb7kgya