🚀 MCP-Pandoc 说明文档

MCP-Pandoc 是一款强大的文件格式转换工具，支持多种常见格式间的转换。用户只需指定内容或文件路径，就能轻松将文本或文件转换为 PDF、Markdown、HTML 等格式，为文件处理带来极大便利。

🚀 快速开始

MCP-Pandoc 能实现多种文件格式间的转换，通过简单的配置和操作，即可完成文件格式的转换。

✨ 主要特性

• 支持多种文件格式转换，如 PDF、Markdown、HTML 等。
• 提供手动和自动两种安装方式，满足不同用户需求。

📦 安装指南

方式一：通过配置文件手动安装

• MacOS：打开 ~/Library/Application\ Support/Claude/claude_desktop_config.json 文件。
• Windows：访问 %APPDATA%/Claude/claude_desktop_config.json 文件。

"mcpServers": {
  "mcp-pandoc": {
    "command": "uv",
    "args": [
      "--directory",
      "<DIRECTORY>/mcp-pandoc",
      "run",
      "mcp-pandoc"
    ]
  }
}

"mcpServers": {
  "mcp-pandoc": {
    "command": "uvx",
    "args": [
      "mcp-pandoc"
    ]
  }
}

方式二：通过 Smithery 自动安装已发布的服务器配置

运行以下 bash 命令，自动使用 Smithery 安装 已发布 的 MCP-Pandoc PyPI 服务：

npx -y @smithery/cli install mcp-pandoc --client claude

⚠️ 重要提示

要使用本地配置的 mcp-pandoc，请参考上方 "开发/未发布的服务器配置" 部分。

📚 详细文档

开发指南

构建与发布

为了将包准备好进行分发，可按以下步骤操作：

1. 同步依赖并更新锁文件：

uv sync

2. 构建发行版本：

uv build

这将在 dist/ 目录下创建源代码和轮格式发行包。

3. 发布到 PyPI：

uv publish

⚠️ 重要提示

您需要通过环境变量或命令行参数设置 PyPI 凭据：

• Token: --token 或 UV_PUBLISH_TOKEN
• 或者使用用户名/密码: --username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

调试指南

由于 MCP 服务器通过标准输入输出运行，调试较为困难。为了获得最佳的调试体验，我们强烈推荐使用 MCP Inspector。

您可以通过以下命令启动 MCP Inspector：

<Inspector 启动命令>

贡献指南

如果您希望为项目贡献力量，请参考 贡献文档 了解如何参与开发和提交代码。

说明：本文档介绍了 MCP-Pandoc 的基本功能、安装方法以及开发配置等信息，帮助用户快速上手使用该工具。