Markdown Sidecar MCP Server
2025.04.02
1
TypeScript文档服务代码生成开发效率
Markdown Sidecar MCP Server 是一个用于从 MCP 服务器提供和访问 NPM 包、Go Modules 或 PyPi 包的 Markdown 文档的结构化工具。它通过将这些 Markdown 文件暴露为 `resources` 或 `tools`，支持智能代码生成。该工具设计用于在项目目录中执行，确保访问始终保持在本地环境的项目目录中。
View on GitHub
Overview
基本能力
产品定位
Markdown Sidecar MCP Server 主要用于为开发人员提供便捷的文档访问和代码生成支持，特别是在处理 NPM 包、Go Modules 或 PyPi 包时。
核心功能
- 结构化文档服务：提供对 Markdown 文档的访问，支持 NPM、Go Modules 和 PyPi 包。
- 智能代码生成：通过暴露
resources或tools支持代码生成。 - 本地环境集成：确保所有操作在本地项目目录中进行，避免外部依赖。
- 多注册表支持：支持
npm、gomodules和pypi三种注册表。
适用场景
- 开发环境：在本地开发环境中快速访问和生成代码文档。
- 代码生成工具：作为代码生成工具的辅助服务，提供文档支持。
- 项目管理：在项目管理中统一管理文档资源。
工具列表
- npx -y markdown-sidecar-mcp：快速安装和启动服务。
- npm run build：构建项目。
- npm run build:mcp：使用 Bun 运行 MCP 服务。
常见问题解答
- PyPi 包文档缺失：许多 PyPi 包没有暴露 Markdown 文档，因此该库默认会挂载 Python
help根文档。 - MCP 原语支持：某些客户端可能不支持
resource类型，因此默认使用tool。
使用教程
使用依赖
- 确保已安装 Node.js 和 npm。
- 确保项目目录中已安装所需的包（NPM、Go Modules 或 PyPi）。
安装教程
npx -y markdown-sidecar-mcp
调试方式
- 安装依赖：
npm i
- 构建项目：
npm run build
- 运行 MCP 服务：
npm run build:mcp