Markdown Sidecar MCP 服务器
这提供了一种结构化的方式,可以从 MCP 服务器为 NPM 包、Go 模块或 PyPi 包提供 Markdown 文档并进行访问。通过将这些 Markdown 文件公开为resources
或tools
,它能够实现明智的代码生成。
[!笔记]
注意:许多 PyPi 包没有公开 markdown 文档,因此该库还将默认安装 python help
根文档。
此操作旨在从已在本地安装所需包的项目目录中执行。访问始终停留在您的本地环境工作目录中。
安装
npx -y markdown-sidecar-mcp
参数
workingDir
:您的 repo 的工作目录。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"
]
}
}
}
发展
# Install dependencies
npm i
# Build
npm run build
# Run with Bun
npm run build:mcp
贡献
- 分叉存储库
- 创建你的功能分支
- 提交更改并推送
- 打开拉取请求
执照
该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅LICENSE文件。