Markdown Sidecar MCP Server

Sirve y accede a documentación markdown de paquetes NPM, Go o PyPi instalados localmente.

Documentación

Markdown Sidecar MCP Server

Esto proporciona una forma estructurada de servir y acceder a documentación Markdown desde un servidor MCP para paquetes NPM, Módulos Go o paquetes PyPi. Permite la generación de código informada al exponer estos archivos Markdown como resources o tools.

[!NOTE]
Nota: Muchos paquetes PyPi no tienen documentación Markdown expuesta, por lo que esta biblioteca también montará los documentos raíz de help de Python por defecto.

Esto está diseñado para ejecutarse desde dentro de un directorio de proyecto donde los paquetes solicitados ya están instalados localmente. El acceso siempre permanece dentro del directorio de trabajo local de tu entorno.

Instalación

npx -y markdown-sidecar-mcp

Argumentos

  • workingDir: El directorio de trabajo de tu repositorio.
  • packageName: El nombre del paquete o módulo a solicitar.
  • registry: Registro donde se encontrará el paquete (npm, gomodules o pypi).
  • docsSubDir: [OPCIONAL] El subdirectorio específico para buscar documentos Markdown. Por defecto es la raíz del paquete.
  • mcpPrimitive: [OPCIONAL] La primitiva MCP a exponer desde el servidor (tool o resource). Esto por defecto es tool, algunos clientes no soportan actualmente recursos.

Pasos de instalación en Cursor

Agrega la siguiente definición de servidor a tu archivo .cursor/mcp.json:

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

Desarrollo

# Install dependencies
npm i

# Build
npm run build

# Run with Bun
npm run build:mcp

Contribuciones

  1. Haz un fork del repositorio
  2. Crea tu rama de características
  3. Haz commit de tus cambios y súbelos
  4. Abre una Solicitud de Pull

Licencia

Este proyecto está licenciado bajo la Licencia MIT - consulta el archivo LICENSE para más detalles.