使用说明

项目简介

Markdownify Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型 (LLM) 应用提供便捷的 Markdown 转换能力。它集成了多种工具,可以将 PDF、图片、音频、Office文档以及网页内容等多种格式转换为 Markdown 文本,从而帮助 LLM 应用更好地理解和处理各种类型的非结构化数据。

主要功能点

  • 多格式文件转 Markdown: 支持 PDF, 图片, 音频 (带转录), DOCX, XLSX, PPTX 等文件格式转换为 Markdown。
  • 网页内容转 Markdown: 支持 YouTube 视频转录, Bing 搜索结果, 普通网页等网页内容转换为 Markdown。
  • 获取 Markdown 文件: 支持直接读取已有的 Markdown 文件内容。
  • MCP 协议支持: 完全兼容 Model Context Protocol,可以与任何 MCP 客户端集成。

安装步骤

  1. 克隆仓库
    git clone https://github.com/briannaluna17/angle
    cd angle
  2. 安装依赖
    pnpm install
    这个命令会自动安装项目依赖,包括 'uv' 和相关的 Python 依赖。
  3. 构建项目
    pnpm run build
  4. 启动服务器
    pnpm start

服务器配置

要将 Markdownify Server 集成到 MCP 客户端,您需要在客户端的服务器配置中添加以下 JSON 配置。请根据您的实际文件路径进行修改。

{
  "mcpServers": {
    "markdownify": {
      "command": "node",
      "args": [
        "{ABSOLUTE PATH TO FILE HERE}/dist/index.js"  // 将 {ABSOLUTE PATH TO FILE HERE} 替换为项目 dist/index.js 文件的绝对路径
      ],
      "env": {
        "UV_PATH": "/path/to/uv" // 可选:如果 uv 不在默认路径,请设置 uv 的安装路径
      }
    }
  }
}

配置参数说明:

  • 'server name': 'markdownify' (服务器名称,客户端用于标识和调用)
  • 'command': 'node' (启动服务器的命令,这里使用 Node.js)
  • 'args': 启动命令的参数,指向 'dist/index.js' 文件,请务必替换为 'dist/index.js' 文件的绝对路径
  • 'env': 环境变量配置(可选),'UV_PATH' 用于指定 'uv' 工具的路径。默认情况下,服务器会尝试使用默认安装位置的 'uv'。

基本使用方法

  1. 启动 Markdownify Server 后,在 MCP 客户端中配置并连接到该服务器。
  2. 客户端可以通过 MCP 协议调用服务器提供的工具,例如:
    • 'youtube-to-markdown': 将 YouTube 视频 URL 转换为 Markdown。
    • 'pdf-to-markdown': 将 PDF 文件路径转换为 Markdown。
    • 'webpage-to-markdown': 将网页 URL 转换为 Markdown。
    • 'get-markdown-file': 获取指定 Markdown 文件路径的内容。
  3. 工具的具体使用方法和参数请参考仓库 'README.md' 文件中 "Available Tools" 部分的描述。

信息

分类

网页与API