markdownify-mcp

🚀 Markdownify MCP 服务器

Markdownify 是一款模型上下文协议（MCP）服务器，它能将多种文件类型以及网络内容转化为 Markdown 格式。借助它提供的一系列工具，可轻松把 PDF、图像、音频文件、网页等内容转换为便于阅读和分享的 Markdown 文本。

🚀 快速开始

克隆仓库

首先，克隆此仓库到本地。

安装依赖

安装项目所需的依赖项，运行以下命令：

pnpm install

⚠️ 重要提示

此操作也将安装 uv 及相关 Python 依赖项。

构建项目

使用以下命令构建项目：

pnpm run build

启动服务器

构建完成后，启动服务器：

pnpm start

✨ 主要特性

• 多种文件类型转换：
  • PDF
  • 图像
  • 带转录的音频
  • DOCX
  • XLSX
  • PPTX
• 网络内容转换：
  • YouTube 视频字幕
  • Bing 搜索结果
  • 通用网页
• 获取现有 Markdown 文件

📦 安装指南

克隆仓库

克隆此仓库到本地。

安装依赖

pnpm install

构建项目

pnpm run build

启动服务器

pnpm start

💻 使用示例

与桌面应用集成使用

要将此服务器与桌面应用集成，请在应用的服务器配置中添加以下内容：

{
  "mcpServers": {
    "markdownify": {
      "command": "node",
      "args": [
        "{ABSOLUTE PATH TO FILE HERE}/dist/index.js"
      ],
      "env": {
        // 默认情况下，服务器将使用 `uv` 的默认安装位置
        "UV_PATH": "/path/to/uv"
      }
    }
  }
}

📚 详细文档

开发相关

• 使用 pnpm run dev 以启动 TypeScript 编译器的监视模式。
• 修改 src/server.ts 可自定义服务器行为。
• 在 src/tools.ts 中添加或修改工具。

可用工具

• youtube-to-markdown：将 YouTube 视频转换为 Markdown。
• pdf-to-markdown：将 PDF 文件转换为 Markdown。
• bing-search-to-markdown：将 Bing 搜索结果转换为 Markdown。
• webpage-to-markdown：将网页内容转换为 Markdown。
• image-to-markdown：将图像转换为 Markdown 并附带元数据。
• audio-to-markdown：将音频文件转换为 Markdown 并附带转录文本。
• docx-to-markdown：将 DOCX 文件转换为 Markdown。
• xlsx-to-markdown：将 XLSX 文件转换为 Markdown。
• pptx-to-markdown：将 PPTX 文件转换为 Markdown。
• get-markdown-file：获取现有 Markdown 文件。

🤝 贡献

欢迎贡献！请随意提交 Pull Request。

📄 许可证

此项目遵循 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。