<div align="center"> <a href="https://www.speakeasy.com/" target="_blank"> <picture> <img width="500" src="https://github.com/user-attachments/assets/90832ba3-1513-497d-b7cf-29368ece57c8" alt="Speakeasy"> </picture> </a> </div>

Markdown Sidecar MCP 服务器

该服务器提供了一种结构化的方式，用于从 MCP 服务器为 NPM 包、Go Modules 或 PyPi 包提供和访问 markdown 文档。它通过将这些 markdown 文件公开为 resources 或 tools，从而实现知情的代码生成。

[!NOTE] 注意：许多 PyPi 包没有公开 markdown 文档，因此该库默认也会挂载 python help 根文档。

该服务器旨在从项目目录中执行，其中请求的包已在本地安装。访问始终保留在您本地环境的工作目录中。

安装

npx -y markdown-sidecar-mcp

参数

• workingDir: 您的仓库的工作目录。
• packageName: 要请求的包或模块的名称。
• registry: 包所在的注册表 (npm、gomodules 或 pypi)。
• docsSubDir: [可选] 要在其中查找 markdown 文档的特定子目录。默认为包根目录。
• mcpPrimitive: [可选] 要从服务器公开的 MCP 原语 (tool 或 resource)。默认为 tool，某些客户端目前不支持 resources。

Cursor 安装步骤

将以下服务器定义添加到您的 .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. Fork 仓库
2. 创建您的特性分支
3. 提交您的更改并推送它们
4. 打开一个 Pull Request

许可证

该项目根据 MIT 许可证授权 - 有关详细信息，请参阅 LICENSE 文件。