mcp-pandoc 使用说明

项目简介

mcp-pandoc 是一个基于 Model Context Protocol (MCP) 的服务器,专注于文档格式转换。它利用 pandoc 强大的文档转换能力,为 LLM 应用提供将内容在不同格式之间转换的工具,例如 Markdown、HTML 和纯文本。

主要功能点

  • 文档格式转换: 提供 'convert-contents' 工具,允许将文本内容从一种格式转换为另一种格式。
  • 支持多种格式: 目前支持 Markdown, HTML, 纯文本格式的转换,未来计划支持 PDF, CSV, DOCX 等更多格式。
  • MCP 协议兼容: 遵循 MCP 协议标准,可以与任何兼容 MCP 协议的客户端(如 Claude)配合使用。

安装步骤

本仓库代码为 MCP 服务器的实现代码,您无需手动安装。该服务已发布,可以直接在 MCP 客户端中配置使用。

服务器配置

要将 mcp-pandoc 服务器配置到 MCP 客户端(例如 Claude),您需要在客户端的配置文件中添加以下服务器配置信息。以下是已发布版本的配置,可以直接使用:

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

配置参数说明:

  • 'server name': 'mcp-pandoc' (服务器名称,用于客户端识别)
  • 'command': 'uvx' (启动命令,'uvx' 用于执行已发布的 Python 包)
  • 'args': '["mcp-pandoc"]' (命令参数,指定要运行的包名为 'mcp-pandoc')

对于开发或未发布版本,可以使用以下配置(请注意替换路径 '/Users/vivekvells/Desktop/code/ai/mcp-pandoc' 为实际代码路径):

{
  "mcpServers": {
    "mcp-pandoc": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/vivekvells/Desktop/code/ai/mcp-pandoc",
        "run",
        "mcp-pandoc"
      ]
    }
  }
}

开发版本配置参数说明:

  • 'server name': 'mcp-pandoc' (服务器名称)
  • 'command': 'uv' (启动命令,'uv' 用于在指定目录下运行 Python 代码)
  • 'args':
    • '"--directory"': 指定服务器代码所在的目录 ('/Users/vivekvells/Desktop/code/ai/mcp-pandoc',需要替换为实际路径)
    • '"run"': uv 命令的子命令,表示运行 Python 包
    • '"mcp-pandoc"': 要运行的 Python 包名

基本使用方法

配置完成后,在支持 MCP 协议的客户端中,您可以使用 'convert-contents' 工具进行文档格式转换。

例如,在 Claude 中,您可以指示 Claude 使用 'convert-contents' 工具将一段 Markdown 文本转换为 HTML 格式。Claude 会调用 mcp-pandoc 服务器执行转换,并将结果返回给您。

工具 'convert-contents' 参数:

  • 'contents': 要转换的文本内容 (字符串)
  • 'output_format': 目标格式,目前支持 'html', 'markdown', 'text' (字符串)
undefined

信息

分类

开发者工具