Markdown Documentation Sidecar

🚀 Markdown Sidecar MCP 服務器

本項目提供了一種結構化的方式，可通過 MCP 服務器為 NPM 包、Go 模塊或 PyPi 包提供服務並訪問 Markdown 文檔。它能將這些 Markdown 文件作為 資源 或 工具 進行暴露，從而讓代碼生成更加智能。

⚠️ 重要提示

許多 PyPi 包沒有公開其 Markdown 文檔，因此此庫默認情況下還會掛載 Python 的 幫助 根文檔。

本項目設計為在已安裝所需包的項目主目錄中執行，且訪問範圍始終侷限於當前工作目錄內。

🚀 快速開始

本項目可幫助你以結構化的方式，通過 MCP 服務器為各類包服務並訪問 Markdown 文檔，提升代碼生成的智能性。

📦 安裝指南

常規安裝

npx -y markdown-sidecar-mcp

光標安裝步驟

將以下服務器定義添加到你的 .cursor/mcp.json 文件中：

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

✨ 主要特性

本項目支持為 NPM 包、Go 模塊或 PyPi 包服務和訪問 Markdown 文檔，通過將 Markdown 文件暴露為 資源 或 工具 使代碼生成更智能。同時，考慮到 PyPi 包的情況，默認掛載 Python 的 幫助 根文檔。

📚 詳細文檔

參數說明

💻 使用示例

開發使用

# 安裝依賴項
npm i

# 構建
npm run build

# 使用 Bun 運行
npm run build:mcp

🤝 貢獻指南

1. 分叉倉庫
2. 創建你的功能分支
3. 提交更改並推送到遠程倉庫
4. 提交拉取請求

📄 許可證

此項目在 MIT 許可證下發布，詳情請參閱 LICENSE 文件。