Markdown Sidecar

Serves and exposes markdown docs from MCP packages as resources or tools to support code generation.

javascript

0

GitHub Stars

javascript

Language

6 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "lwsinclair-markdown-sidecar-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "--package",
        "markdown-sidecar-mcp",
        "--",
        "mcp",
        "start",
        "--workingDir",
        "{REPO_WORKING_DIR}",
        "--packageName",
        "{PACKAGE_NAME}",
        "--registry",
        "npm"
      ]
    }
  }
}

This MCP server lets you serve and access markdown documentation from MCP-enabled packages locally, exposing them as resources or tools to support informed code generation within your project workspace.

How to use

You run the sidecar MCP server from within your project directory where the requested packages are already installed. The server exposes markdown docs from NPM packages, Go Modules, or PyPi packages so you can reference them as resources or tools during code generation. Access stays entirely within your local working directory, keeping your environment isolated.

How to install

Prerequisites you need on your machine before starting are Node.js and npm (Node.js 12+ recommended). You will use the MCP endpoints by invoking the sidecar via npx.

Install and run the sidecar MCP server from a terminal in your project directory:

npx -y markdown-sidecar-mcp

Additional setup steps you may need

If you want to define the server in your workspace configuration, add a sidecar MCP server definition to your Cursor configuration so clients can start the server automatically with your workspace.

{
  "mcpServers": {
    "sidecar": {
      "command": "npx",
      "args": [
        "-y", "--package", "markdown-sidecar-mcp",
        "--", "mcp", "start",
        "--workingDir", "{REPO_WORKING_DIR}",
        "--packageName", "{PACKAGE_NAME}",
        "--registry", "npm"
      ]
    }
  }
}

Notes

This server is designed to be executed from within your project directory where the requested packages are installed locally. You can customize which Markdown docs are exposed by specifying the package and, optionally, a subdirectory to search for docs within that package.

Security and usage notes

Run the server only in trusted development environments. Treat the exposed Markdown docs as read-only references for documentation review and code generation to avoid unintended modification of package data.