Pdfdancer MCP

pdfdancer mcp

将PDFDancer添加到您的AI编码助手

编辑任何真实PDF中的文本。即使是那些你没有创造的。PDFDancer像真正的文档格式一样编辑入站PDF：段落、线条、字形、矢量、表单，以及针对缺失或嵌入字体的ML驱动字体处理。

pdfdancer-mcp 是一个模型上下文协议（MCP）服务器，它将PDFDancer连接到MCP兼容的AI编码助手，以便他们可以在您的项目（TypeScript、Python和Java）中编写、运行和重构PDFDancer SDK代码。使用它来构建和维护服务、工作流和工具，以转换您没有创建的PDF。非常适合需要在生产中修改PDF的摄取管道、文档工作流和AI代理。

PDF过去是只读的。我们解决了这个问题。

______________________________________________________________________

对于用户

需求

• Node.js >=v18.0.0
• MCP客户端：Cursor、Claude Code、VS Code、Windsurf、Zed或任何其他MCP兼容客户端

安装

将此MCP服务器添加到您首选的AI编码助手中。请在下面选择您的客户端以获取具体的安装说明。

Install in Cursor

选项1：一键安装（推荐）

单击下面的按钮在Cursor中安装pdfdancer mcp：

选项2：手动配置

1. 打开光标设置
2. 导航到“MCP”部分
3. 添加以下配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Claude Code

选项1:CLI命令（推荐）

在终端中运行以下命令：

claude mcp add --transport stdio pdfdancer-mcp -- npx -y @pdfdancer/pdfdancer-mcp

使用以下工具验证安装： claude mcp list

选项2：手动配置

将以下内容添加到您的Claude Code MCP设置配置文件中：

位置: ~/.config/claude/claude_desktop_config.json （Linux/macOS）或 %APPDATA%\Claude\claude_desktop_config.json （Windows）

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

添加配置后，重新启动Claude Code以激活MCP服务器。

Install in Claude Desktop

选项1：桌面扩展（最简单-即将推出）

如果可用，请导航到“设置”>“扩展”>“浏览扩展”，然后搜索“pdfdancer mcp”进行一键安装。

选项2：手动配置

将以下内容添加到您的Claude Desktop MCP设置配置文件中：

位置: ~/Library/Application Support/Claude/claude_desktop_config.json （macOS）或 %APPDATA%\Claude\claude_desktop_config.json （Windows）

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

添加配置后，重新启动Claude Desktop以激活MCP服务器。

Install in Windsurf

选项1：使用设置UI（推荐）

1. 打开风帆设置（单击右下角的风帆图标，或Cmd+Shift+P/Ctrl+Shift+P，然后键入“打开风帆设置”）
2. 导航到“高级设置”>“级联”>“模型上下文协议”
3. 单击MCP服务器按钮（锤形图标），然后单击配置
4. 使用配置界面添加服务器

选项2：手动配置

编辑 mcp_config.json 文件并添加：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in VS Code / VS Code Insiders

在VS Code中使用MCP兼容扩展时：

1. 安装MCP客户端扩展（如Cline、Roo Code或类似扩展）
2. 打开扩展的设置
3. 添加MCP服务器配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Cline (VS Code Extension)

选项1：使用AI助手（最简单）

在Cline聊天机器人中，使用以下提示：

install the MCP server named `@pdfdancer/pdfdancer-mcp` for Cline - ensure the mcp settings are updated

选项2：使用MCP服务器UI

1. 单击Cline顶部导航栏中的MCP服务器图标
2. 选择“配置MCP服务器”
3. 浏览MCP市场或手动添加

选项3：手动配置

编辑 cline_mcp_settings.json:

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Zed

选项1：扩展方法（推荐-如果可用）

1. 打开命令面板（搜索“zed:extensions”）
2. 查看扩展市场中的“pdfdancer mcp”
3. 安装扩展程序（如果可用）-Zed将指导您完成安装

选项2：通过UI自定义服务器

1. 打开代理面板的设置视图（或使用“代理：打开设置”操作）
2. 在上下文服务器部分，单击“+添加上下文服务器”
3. 输入服务器名称： pdfdancer-mcp
4. 单击添加服务器并配置：

- 命令: npx - 参数: -y @pdfdancer/pdfdancer-mcp

选项3：手动配置

打开Zed设置(~/.config/zed/settings.json)并添加：

{
  "assistant": {
    "version": "2",
    "mcp_servers": [
      {
        "id": "pdfdancer-mcp",
        "command": "npx",
        "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
      }
    ]
  }
}

通过检查代理面板设置中服务器名称旁边的指示点进行验证-绿色表示它运行正常。

Install in Augment Code

选项1：简易MCP（推荐）

Augment Code的“Easy MCP”功能为流行工具提供了一键集成。检查设置中的Easy MCP面板，以便快速安装。

选项2:UI配置

1. 打开增强代码设置
2. 导航到MCP服务器
3. 点击“添加服务器”
4. 输入：

- 名字: pdfdancer-mcp - 命令: npx - 参数: -y @pdfdancer/pdfdancer-mcp

选项3：手动配置

编辑您的增强代码配置文件：

{
  "augment.advanced": {
    "mcpServers": [{
      "name": "pdfdancer-mcp",
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }]
  }
}

Install in Roo Code

选项1：使用MCP设置面板（推荐）

1. 单击Roo Code MCP图标
2. 点击“编辑全局MCP”
3. 将以下配置粘贴到 mcpServers 对象
4. 保存文件

选项2：手动配置

编辑 mcp_settings.json （全球）或 .roo/mcp.json （项目层面）：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

备注：全局配置适用于所有工作区，而项目级别特定于项目的根。

Install in Gemini CLI

添加到Gemini CLI配置中：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Qwen Coder

添加到您的Qwen编码器MCP设置中：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in JetBrains AI Assistant

需求：IntelliJ IDEA 2025.1+或其他配备AI助手的JetBrains集成开发环境251.26094.80.5+

选项1：从克劳德进口（最简单）

1. 转到设置|工具| AI助手|模型上下文协议（MCP）
2. 点击“从克劳德导入”
3. 从Claude Desktop配置中选择pdfdancer mcp服务器

选项2：通过设置UI添加

1. 打开IDE设置（Ctrl+Alt+S或Cmd+，）
2. 导航到“工具”→ AI助手→ 模型上下文协议（MCP）
3. 点击“添加命令”或使用添加选项
4. 配置：

- 名字: pdfdancer-mcp - 命令: npx - 参数: -y @pdfdancer/pdfdancer-mcp

选项3：手动配置

添加到MCP配置中：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

备注：版本2025.2+包括对外部客户端的内置MCP服务器支持。

Install in Amazon Q Developer CLI

在Amazon Q Developer CLI设置中配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Warp

添加到Warp的AI配置中：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in GitHub Copilot CLI

在GitHub Copilot CLI设置中配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in BoltAI

添加到BoltAI MCP配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Perplexity Desktop

在困惑桌面设置中配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

Install in Docker

添加到Docker容器配置中：

FROM node:18

RUN npx -y @pdfdancer/pdfdancer-mcp

或者在docker compose中使用：

services:
  pdfdancer-mcp:
    image: node:18
    command: npx -y @pdfdancer/pdfdancer-mcp

Other MCP-Compatible Clients

对于任何其他MCP兼容客户端，请使用以下标准配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"]
    }
  }
}

有关MCP配置文件的具体位置，请参阅客户的文档。

自定义文档终结点（可选）

如果您使用的是自定义PDFDancer文档端点，您可以通过环境变量对其进行配置：

{
  "mcpServers": {
    "pdfdancer-mcp": {
      "command": "npx",
      "args": ["-y", "@pdfdancer/pdfdancer-mcp"],
      "env": {
        "PDFDANCER_DOCS_BASE_URL": "https://your-docs-endpoint.com"
      }
    }
  }
}

可用工具

MCP服务器提供以下工具用于访问PDFDancer文档：

• help –通过多语言代码示例（TypeScript、Python、Java）展示PDFDancer SDK功能的全面概述，演示常见的PDF操作任务。

• version –获取pdfdancer mcp服务器的当前版本。

• search-docs –按关键字搜索PDFDancer SDK官方文档。返回匹配的文档路径，包括标题、内容片段和相关性得分（最多10个结果）。使用此功能查找有关PDFDancer功能、API和使用示例的信息。

• get-docs –检索特定路线的完整文档内容。在找到相关文件后 search-docs，使用此工具获取完整的markdown内容，包括代码示例、详细说明和API参考。

典型工作流程

1. 安装服务器 在您的MCP兼容客户端（Cursor、Claude Code、Windsurf、Zed等）中。
2. 打开一个使用PDFDancer的代码库 （或让您的助手添加SDK）。
3. 在代码中描述你想要的行为 –例如：“添加一个步骤，在每个入站PDF中编辑电子邮件地址”，“添加一种将此页眉向上移动20px的函数”，或“创建一个在所有页面上加盖页脚的作业”。
4. 让代理编写和重构代码 通过此MCP服务器使用PDFDancer SDK，然后运行测试或示例PDF。
5. 提交并发布您的工作流程 一旦代码和生成的PDF按预期运行。

演示：使用带有Claude代码的PDFDancer MCP

安装PDFDancer MCP服务器后，您可以提示Claude Code构建PDF应用程序。这是一个真实的终端会话：

发生了什么：

1. 用户提示： create a typescript project which creates a pdf with the words "Hello World" on it. Use pdfdancer
2. Claude Code使用MCP搜索PDFDancer文档
3. 通过正确的设置创建了一个完整的TypeScript项目
4. 构建并运行该项目
5. 生成 output.pdf 带有“Hello World”文本

PDFDancer MCP使Claude Code能够立即提供准确、最新的文档和代码示例，而不会产生幻觉API。

______________________________________________________________________

对于开发者

发展

npm install
npm run dev   # starts the server via tsx for quick iteration
npm run build # emits ESM output to dist/
npm run lint  # type-check without emitting files

发布到npm

该包被配置为在发布之前自动构建和lint：

# Login to npm (first time only)
npm login

# Publish to npm (prepublishOnly script runs automatically)
npm run publish:npm

或者使用标准的npm publish命令：

npm publish

这 prepublishOnly 该脚本确保在每次发布之前对包进行过梁和构建。

本地测试

1. 构建可分发文件，使CLI与最终的npm工件相匹配：

   npm run build

1. 完全按照以下步骤启动stdio服务器 npx 会，但指向本地包目录：

   npx -y .

1. 或者，直接使用Node运行编译后的输出：

   node dist/index.js

1. 为了在编辑TypeScript时获得最快的内部循环，请使用：

   npm run dev

任何兼容MCP的客户端（Claude Desktop、MCP CLI等）现在都可以通过stdio连接到正在运行的进程。

配置

集 PDFDANCER_DOCS_BASE_URL 如果与默认值不同，则指向您的PDFDancer文档服务端点。服务器默认使用PDFDancer官方文档服务。

例子：

export PDFDANCER_DOCS_BASE_URL=https://your-docs-endpoint.com
npx -y . # or npm run dev

有用的链接

• API文档
• 产品概述
• 更新日志
• 状态
• 问题跟踪器