Markdown Sidecar MCP Server

Markdown Sidecar MCP Server

Isso fornece uma maneira estruturada de servir e acessar documentação markdown de um servidor MCP para pacotes NPM, Go Modules ou pacotes PyPi. Ele permite a geração de código informada ao expor esses arquivos markdown como resources ou tools.

[!NOTE]
Nota: Muitos pacotes PyPi não têm documentação markdown exposta, então esta biblioteca também montará os documentos raiz do python help por padrão.

Isso é projetado para ser executado a partir de um diretório de projeto onde os pacotes solicitados já estão instalados localmente. O acesso permanece sempre dentro do diretório de trabalho do seu ambiente local.

Instalação

npx -y markdown-sidecar-mcp

Argumentos

• workingDir: O diretório de trabalho do seu repositório.
• packageName: O nome do pacote ou módulo a ser solicitado.
• registry: Registro onde o pacote será encontrado (npm, gomodules ou pypi)
• docsSubDir: [OPCIONAL] O subdiretório específico para procurar documentos markdown. Padrão é a raiz do pacote.
• mcpPrimitive: [OPCIONAL] A primitiva MCP a ser exposta pelo servidor (tool ou resource). O padrão é tool, alguns clientes não suportam recursos atualmente.

Passos de Instalação no Cursor

Adicione a seguinte definição de servidor ao seu arquivo .cursor/mcp.json:

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

Desenvolvimento

# Install dependencies
npm i

# Build
npm run build

# Run with Bun
npm run build:mcp

Contribuindo

1. Faça um fork do repositório
2. Crie sua branch de funcionalidade
3. Faça commit das suas alterações e envie-as
4. Abra um Pull Request

Licença

Este projeto é licenciado sob a Licença MIT - veja o arquivo LICENÇA para detalhes.