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 文件。