使用说明
项目简介
pdf-mcp-tools 是一个基于 Model Context Protocol (MCP) 构建的服务器应用,专注于提供 PDF 文档处理能力。它通过 MCP 协议与客户端通信,允许客户端调用预定义的工具来执行各种 PDF 操作,例如移除指定页面、合并多个 PDF 文件以及在 PDF 文档中添加自定义文本水印。
主要功能点
- 移除PDF页面: 允许用户指定要从 PDF 文档中删除的页面,支持按页码删除。
- 合并PDF文件: 支持将多个 PDF 文件合并为一个单独的 PDF 文档。
- 添加文本水印: 可以在 PDF 文档的每一页添加自定义文本水印,并可设置水印的位置、字体、颜色、透明度和旋转角度。
安装步骤
- 安装 Node.js 和 npm: 确保你的系统中已安装 Node.js 和 npm (Node Package Manager)。
- 克隆仓库: 使用 Git 克隆 pdf-mcp-tools 仓库到本地:
git clone https://github.com/alanhe421/pdf-mcp-tools.git - 进入项目目录: 导航到克隆下来的仓库目录:
cd pdf-mcp-tools - 安装依赖: 使用 npm 安装项目依赖:
npm install - 构建项目: 执行构建脚本编译 TypeScript 代码 (如果需要,通常 'npm install' 会自动执行 'npm run build',如果 'build' 目录不存在,可以手动运行):
npm run build
服务器配置
MCP 客户端需要配置以下信息以连接到 pdf-mcp-tools 服务器。配置通常为 JSON 格式,用于告知客户端如何启动和连接服务器。
{ "serverName": "pdf-server", // MCP 服务器名称,与代码中定义的一致 "command": "npx", // 启动服务器的命令,这里使用 npx 运行 pdf-mcp "args": ["pdf-mcp"] // 命令参数,npx pdf-mcp 会执行项目根目录或 package.json 中配置的 pdf-mcp 命令 // 或者,如果直接运行构建后的 JavaScript 文件,可以使用以下配置: // "command": "node", // "args": ["build/index.js"] // 确保 npx 和 node 命令在 MCP 客户端的运行环境中可用,并且 pdf-mcp 或 build/index.js 脚本可执行。 // 该服务器通过标准输入/输出 (stdio) 进行通信。 }
基本使用方法
- 启动服务器: MCP 客户端根据上述配置启动 pdf-mcp-tools 服务器。服务器将在 stdio 上监听 MCP 请求。
- 客户端发送请求: MCP 客户端可以使用 JSON-RPC 协议向服务器发送请求,调用已注册的工具 (Tools)。
- 可用的工具 (Tools):
- 'remove-pdf-pages': 移除 PDF 文档的指定页面。
- 参数: 'pdfPath' (PDF文件绝对路径), 'pageNumbers' (要移除的页码数组,页码从1开始)。
- 'merge-pdfs': 合并多个 PDF 文件。
- 参数: 'pdfPaths' (PDF文件绝对路径数组), 'outputPath' (合并后 PDF 的输出路径)。
- 'add-text-watermark': 添加文本水印到 PDF 文档。
- 参数: 'watermarkText' (水印文本内容), 'pdfPath' (PDF文件绝对路径), 'position' (水印位置,可选值: "center", "top", "bottom", "topLeft", "topRight", "bottomLeft", "bottomRight",默认为 "center")。
- 'remove-pdf-pages': 移除 PDF 文档的指定页面。
客户端需要构造符合 MCP 协议的 JSON-RPC 请求,并发送到服务器的标准输入,服务器处理请求后将响应发送到标准输出。具体请求格式和参数请参考 Model Context Protocol 的官方文档。
信息
分类
生产力应用