Markdown to PDF Converter MCP Server 使用说明
项目简介
Markdown to PDF Converter MCP Server (md-pdf-mcp) 是一个基于 Model Context Protocol (MCP) 构建的后端应用,它专注于将 Markdown 格式的文档转换为精美的 PDF 文件,并采用了与 VS Code 编辑器一致的样式风格。作为一个 MCP 服务器,它能够与支持 MCP 协议的客户端(如 Claude)进行交互,提供资源访问、工具调用和 Prompt 模板等服务,从而扩展 LLM 应用的功能。
主要功能点
- Markdown to PDF 转换: 核心功能是将 Markdown 文本转换为 PDF 文件,转换后的 PDF 文件具有与 VS Code 编辑器中 Markdown 预览相同的样式,保证了美观和一致性。
- 资源管理 (Resources):
- 实现了简单的笔记存储系统。
- 定义了 'note://' URI scheme 用于访问和管理笔记资源。
- 每个笔记资源包含名称、描述和 'text/plain' MIME 类型。
- Prompt 模板 (Prompts):
- 提供了 'summarize-notes' Prompt,用于总结所有存储的笔记内容。
- 'summarize-notes' Prompt 支持可选的 'style' 参数,可以控制摘要的详细程度('brief' 或 'detailed')。
- 工具 (Tools):
- 实现了 'add-note' 工具,允许客户端向服务器添加新的笔记。
- 'add-note' 工具接受 'name' 和 'content' 两个字符串参数。
- 添加笔记后,服务器状态更新,并通知客户端资源变更。
安装步骤
- 环境准备: 确保你的系统中安装了 Python 3.8 或更高版本,并且安装了 'uv' 包管理器 (参考仓库 README)。
- 下载仓库: 从 GitHub 克隆或下载 'md-pdf-mcp' 仓库到本地。
- 安装依赖: 在仓库根目录下,打开终端并运行命令 'uv sync' 以同步依赖并更新 lockfile,或者运行 'pip install .' 安装项目及其依赖。
服务器配置
要将 'md-pdf-mcp' 配置为 MCP 服务器供 MCP 客户端使用,你需要编辑 MCP 客户端的配置文件(例如 Claude Desktop 的 'claude_desktop_config.json')。在配置文件中添加 'mcpServers' 字段,并配置 'md-pdf-mcp' 服务器的信息。
开发/未发布服务器配置 (Development/Unpublished Servers Configuration):
"mcpServers": { "md-pdf-mcp": { "command": "uv", "args": [ "--directory", "/path/to/your/local/md-pdf-mcp", // 将 "/path/to/your/local/md-pdf-mcp" 替换为 md-pdf-mcp 仓库在您本地的实际路径 "run", "md-pdf-mcp" ] } }
发布服务器配置 (Published Servers Configuration):
如果服务器已打包并发布,可以使用以下配置:
"mcpServers": { "md-pdf-mcp": { "command": "uvx", "args": [ "md-pdf-mcp" ] } }
基本使用方法
- 启动服务器: 根据上述配置,MCP 客户端将使用配置的命令和参数启动 'md-pdf-mcp' 服务器。
- 客户端交互: 在 MCP 客户端中,你可以:
- 访问资源: 使用 'note://' URI 访问和读取服务器上存储的笔记资源。
- 调用工具: 调用 'add-note' 工具向服务器添加新的笔记。
- 使用 Prompt: 使用 'summarize-notes' Prompt 让 LLM 总结笔记内容,并可以通过 'style' 参数控制摘要风格。
- Markdown to PDF 转换: 虽然仓库描述和代码中主要侧重于笔记管理,但核心功能是将 Markdown 转换为 PDF。目前提供的工具和 Prompt 似乎没有直接触发 Markdown 到 PDF 的转换功能。根据代码分析,可能需要开发者扩展工具或 Prompt 来利用 'convert_markdown_to_pdf' 函数,实现通过 MCP 客户端请求进行 Markdown 到 PDF 的转换。
注意: 当前仓库提供的 'server.py' 文件 ('src/md_pdf_mcp/server.py') 与根目录下的 'md_pdf_mcp/server.py' 文件内容不同。根目录下的 'md_pdf_mcp/server.py' 文件更像是实现了 Markdown to PDF 转换功能的 MCP 服务器,而 'src/md_pdf_mcp/server.py' 文件更像是一个简单的笔记管理 MCP 服务器示例。 使用时请注意选择合适的 'server.py' 文件运行,或者根据需要进行代码调整。 建议以根目录下的 'md_pdf_mcp/server.py' 为准,因为它更符合仓库 'README.md' 的描述。
信息
分类
开发者工具