使用说明

项目简介

MarkItDown MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，它使用 MarkItDown 工具将各种文件格式转换为 Markdown 文本。此服务器旨在为大型语言模型 (LLM) 应用提供文档转换服务，使其能够理解和处理多种格式的文档内容。

主要功能点

多格式支持: 支持 PDF, PowerPoint, Word, Excel, 图片 (EXIF 元数据和 OCR), 音频 (EXIF 元数据和语音转录), HTML, 文本格式 (CSV, JSON, XML), ZIP 文件等多种文件格式。
Markdown 转换: 将上述格式的文件转换为 Markdown 文本，方便 LLM 理解和处理文档内容。
MCP 协议支持: 遵循 MCP 协议，可以与任何兼容 MCP 协议的客户端集成，如 Zed Editor 等。
Prompt 接口: 提供 '/md <file>' 命令，允许客户端通过 Prompt 方式请求文件转换服务。

安装步骤

手动安装

克隆仓库: 将 GitHub 仓库 'https://github.com/KorigamiK/markitdown_mcp_server' 克隆到本地。
安装依赖: 在克隆的仓库目录下，运行 'uv install' 命令安装项目依赖。 (请确保已安装 'uv' 包管理器)

通过 Smithery 安装 (Claude Desktop 自动安装)

npx -y @smithery/cli install @KorigamiK/markitdown_mcp_server --client claude

服务器配置

要将 MarkItDown MCP Server 集成到 MCP 客户端（例如 Zed Editor），您需要配置客户端以连接到此服务器。以下是针对 Zed Editor 的 'settings.json' 配置示例，展示了如何配置服务器的启动命令。

"context_servers": {
  "markitdown_mcp": {
    "settings": {},
    "command": {
      "path": "uv",  // 服务器启动命令，这里使用 uv 包管理器运行脚本
      "args": [
        "--directory",  // 指定工作目录
        "/path/to/markitdown_mcp_server", //  请替换为 MarkItDown MCP Server 仓库的本地路径
        "run",          //  uv run 命令，用于运行 Python 脚本
        "markitdown_mcp_server"  //  指定要运行的 Python 模块名，对应仓库中的 src/markitdown_mcp_server/__init__.py
      ]
    }
  }
}

配置说明:

'"path": "uv"': 指定用于启动服务器的命令为 'uv'，你需要确保你的系统安装了 'uv' 包管理器，并且 'uv' 命令在你的 PATH 环境变量中。
'"args": [...]': 'args' 数组包含了传递给 'uv' 命令的参数。
- '"--directory", "/path/to/markitdown_mcp_server"': 指定 'uv' 命令的工作目录为 MarkItDown MCP Server 仓库的根目录。请务必将 '/path/to/markitdown_mcp_server' 替换为你实际的仓库路径。
- '"run", "markitdown_mcp_server"': 指示 'uv' 运行 'markitdown_mcp_server' 模块，这会执行 'src/markitdown_mcp_server/init.py' 文件中的 'main()' 函数，从而启动 MCP 服务器。

注意: 你需要根据你的实际环境和 MCP 客户端的要求进行相应的配置调整。例如，如果你的 MCP 客户端支持其他连接方式（如 WebSocket, SSE），并且服务器也支持，你可能需要修改配置以使用这些连接方式。

基本使用方法

启动服务器: 根据上述配置，在 MCP 客户端中启动 'markitdown_mcp' 服务器。服务器将在后台运行并等待客户端请求。
发送 Prompt 请求: 在 MCP 客户端中，可以使用 '/md <file>' 命令向服务器发送文件转换请求。
- 将 '<file>' 替换为你要转换的文件的 URI 或本地文件路径。例如，要转换名为 'document.pdf' 的文件，可以发送命令 '/md document.pdf'。
接收 Markdown 结果: 服务器会将指定文件转换为 Markdown 格式，并将结果作为 Prompt 响应返回给 MCP 客户端。客户端可以接收并展示转换后的 Markdown 内容。

示例命令:

/md my_report.docx

关键词