使用说明

项目简介

Markdownify Server 是一个基于 Model Context Protocol (MCP) 的服务器，它提供了一系列工具，可以将各种文件类型（如 PDF, 图片, 音频, DOCX, XLSX, PPTX）和网页内容（如 YouTube 视频, 网页）转换为 Markdown 格式，方便 LLM 应用获取和处理信息。

主要功能点

多种文件格式转 Markdown: 支持将 PDF, 图片, 音频, DOCX, XLSX, PPTX 等文件转换为 Markdown 格式。
网页内容转 Markdown: 支持将 YouTube 视频, 网页, Bing 搜索结果等网页内容转换为 Markdown 格式。
获取已有的 Markdown 文件: 可以读取服务器本地已存在的 Markdown 文件。

安装步骤

克隆仓库

git clone https://github.com/soonstal/reach.git
cd reach

安装依赖
```
pnpm install
```
这个命令会同时安装 JavaScript 和 Python 依赖。
构建项目
```
pnpm run build
```
启动服务器
```
pnpm start
```
服务器默认使用标准输入输出 (stdio) 协议与 MCP 客户端通信。

服务器配置

要将 Markdownify Server 集成到 MCP 客户端应用中，您需要在客户端的 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 不在默认路径下，请指定 uv 的安装路径
      }
    }
  }
}

配置说明:

'command': 启动服务器的命令，这里使用 'node' 运行 JavaScript 文件。
'args': 启动命令的参数，这里指向编译后的服务器入口文件 'dist/index.js' 的绝对路径。你需要将 '{ABSOLUTE PATH TO FILE HERE}' 替换为实际的绝对路径。
'env': 环境变量配置，'UV_PATH' 用于指定 'uv' (Python 虚拟环境和包管理工具) 的可执行文件路径。如果你的 'uv' 安装路径不在默认位置，需要在此处指定。通常情况下，如果 'uv' 已添加到系统 PATH 环境变量，则无需配置 'UV_PATH'。

基本使用方法

配置完成后，MCP 客户端即可连接到 Markdownify Server。客户端可以通过发送符合 MCP 协议的 JSON-RPC 请求来调用服务器提供的工具。

例如，要将一个 PDF 文件转换为 Markdown，客户端可以调用 'pdf-to-markdown' 工具，并提供 PDF 文件的绝对路径作为参数。服务器会将 PDF 文件转换为 Markdown 文本，并将结果返回给客户端。

可用工具 (详细参数请参考仓库 '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 文件内容。

关键词