Markdown Sidecar MCP Server

Integrations

  • Serves markdown documentation files as resources or tools, providing structured access to documentation content for AI assistants

  • Enables access to markdown documentation from NPM packages, allowing AI agents to browse package documentation for better code generation

  • Provides structured access to markdown documentation and Python help docs from PyPI packages, enhancing AI understanding of Python libraries

Markdown Sidecar MCP 服务器

这提供了一种结构化的方式,可以从 MCP 服务器为 NPM 包、Go 模块或 PyPi 包提供 Markdown 文档并进行访问。通过将这些 Markdown 文件公开为resourcestools ,它能够实现明智的代码生成。

[!笔记]
注意:许多 PyPi 包没有公开 markdown 文档,因此该库还将默认安装 python help根文档。

此操作旨在从已在本地安装所需包的项目目录中执行。访问始终停留在您的本地环境工作目录中。

安装

npx -y markdown-sidecar-mcp

参数

  • workingDir :您的 repo 的工作目录。
  • packageName :要请求的包或模块的名称
  • registry :软件包所在的注册表( npmgomodulespypi
  • docsSubDir[可选] 查找 markdown 文档的特定子目录。默认为包根目录。
  • mcpPrimitive[可选] 需要从服务器公开的 MCP 原语( toolresource )。默认为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

贡献

  1. 分叉存储库
  2. 创建你的功能分支
  3. 提交更改并推送
  4. 打开拉取请求

执照

该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅LICENSE文件。

-
security - not tested
A
license - permissive license
-
quality - not tested

该服务器提供对来自 NPM 包、Go 模块或 PyPi 包的 markdown 文档的结构化访问,通过将这些文档公开为资源或工具来实现明智的代码生成。

  1. Installation
    1. Arguments
      1. Cursor Installation Steps
        1. Development
          1. Contributing
            1. License
              ID: 2wznb7kgya