Markdown Sidecar MCP 服务器

此项目提供了一种结构化的方式，用于通过 MCP 服务器为 NPM 包、Go 模块或 PyPi 包服务和访问 Markdown 文档。它使代码生成更加智能，通过将这些 Markdown 文件暴露为 资源 或 工具。

[!NOTE]
注意：许多 PyPi 包没有公开其 Markdown 文档，因此此库默认情况下还会挂载 Python 的 帮助 根文档。

此项目设计用于在项目的主目录中执行，其中已安装了请求的包。访问始终保留在你当前工作目录内。

安装

npx -y markdown-sidecar-mcp

参数

• workingDir: 你的项目仓库的工作目录。
• packageName: 请求的包或模块的名称
• registry: 包所在的注册表（npm, gomodules, 或 pypi）
• docsSubDir: [可选] 查找 Markdown 文档的具体子目录。默认为包根目录。
• mcpPrimitive: [可选] 从服务器暴露的 MCP 原语 (tool 或 resource)。默认为 tool，某些客户端当前不支持 资源。

光标安装步骤

将以下服务器定义添加到你的 .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 i

# 构建
npm run build

# 使用 Bun 运行
npm run build:mcp

贡献指南

1. 分叉仓库
2. 创建你的功能分支
3. 提交更改并推送到远程仓库
4. 提交拉取请求

许可证

此项目在 MIT 许可证下发布，详情请参阅 LICENSE 文件。