项目简介
Markdownify MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,专注于将各种文件类型和网页内容转换为 Markdown 格式。它为 LLM 应用提供了一组工具,使其能够轻松地将 PDF、图片、音频、网页等内容转换为易于阅读和处理的 Markdown 文本。
主要功能点
- 多种文件类型转 Markdown: 支持 PDF, 图片, 音频 (带转录), DOCX, XLSX, PPTX 等文件格式转换为 Markdown。
- 网页内容转 Markdown: 支持 YouTube 视频转录, Bing 搜索结果, 普通网页等网页内容转换为 Markdown。
- 获取 Markdown 文件: 提供工具直接读取已有的 Markdown 文件内容。
- 标准 MCP 服务器: 遵循 MCP 协议,易于集成到支持 MCP 协议的 LLM 应用中。
安装步骤
-
克隆仓库
git clone https://github.com/soonstal/operation cd operation -
安装依赖
pnpm install这个命令会安装项目依赖,包括 'uv' 和相关的 Python 依赖。
-
构建项目
pnpm run build -
启动服务器
pnpm start服务器默认在终端前台运行。
服务器配置
要将 Markdownify MCP Server 集成到 MCP 客户端应用中,您需要在客户端应用的服务器配置中添加以下 JSON 配置信息。请根据您的实际文件路径进行修改。
{ "mcpServers": { "markdownify": { "command": "node", "args": [ "{ABSOLUTE PATH TO FILE HERE}/dist/index.js" // 将 {ABSOLUTE PATH TO FILE HERE} 替换为您的 operation 仓库 dist/index.js 文件的绝对路径 ], "env": { "UV_PATH": "/path/to/uv" // 可选配置: uv 可执行文件的路径,如果 uv 已在系统 PATH 环境变量中,则无需配置 } } } }
配置参数说明:
- 'server name': 'markdownify' - 服务器的名称,客户端使用此名称来标识和调用该服务器。
- 'command': 'node' - 启动服务器的命令,这里使用 Node.js 运行时环境。
- 'args': 启动命令的参数,指向服务器入口文件 'dist/index.js' 的绝对路径。请务必将 '{ABSOLUTE PATH TO FILE HERE}' 替换为实际的路径。 例如,如果您的仓库克隆在 '/Users/yourname/operation',则应修改为 '/Users/yourname/operation/dist/index.js'。
- 'env': 环境变量配置,'UV_PATH' 用于指定 'uv' 可执行文件的路径。如果 'uv' 已经添加到系统的 'PATH' 环境变量中,可以省略此配置。默认情况下,服务器会尝试使用 'uv' 的默认安装位置。
基本使用方法
Markdownify MCP Server 作为一个 MCP 服务器,需要通过 MCP 客户端应用来使用。客户端应用需要配置上述服务器信息,并在需要时调用服务器提供的工具。
可用工具 (Tools):
服务器提供了以下工具,客户端可以根据需要调用:
- '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 文件内容。
使用示例:
客户端应用可以通过 JSON-RPC 协议向 Markdownify MCP Server 发送 'CallToolRequest' 请求来调用工具,例如调用 'pdf-to-markdown' 工具将 PDF 文件转换为 Markdown。具体的请求格式和调用方式请参考 MCP 协议文档和客户端应用的使用说明。
信息
分类
开发者工具