DocumentFactory MCP服务器
这是DocumentFactory管道的MCP（模型上下文协议）服务器。它在本地运行，并连接到NATS服务器以处理文档作业，实现与AI工具和工作流的无缝集成。
这是什么？
DocumentFactory MCP Server允许AI助手和其他MCP兼容客户端与您的文档处理管道进行交互。它通过NATS消息传递在AI工具（如Claude、ChatGPT或VS Code扩展）和DocumentFactory基础架构之间架起了一座桥梁。
安装
使用DocumentFactory MCP服务器的最简单方法是使用NPX：
npx @documentfactory/mcp-server这会自动下载并运行适用于您平台的正确二进制文件，无需手动安装！
配置
许可证密钥设置
服务器需要许可证密钥来区分演示和许可使用：
- 示范模式：不需要许可证密钥。转换后的PDF将包含水印。
- 许可模式：提供有效的许可证密钥，以从转换后的PDF中删除水印。
设置许可证密钥：
在Linux/macOS上：
LICENCEKEY="your-license-key" npx @documentfactory/mcp-server在Windows上（命令提示符）：
set LICENCEKEY=your-license-key && npx @documentfactory/mcp-server在Windows（PowerShell）上：
$env:LICENCEKEY="your-license-key"; npx @documentfactory/mcp-server如果没有提供许可证密钥，服务器将以带有水印输出的演示模式运行。
用法
此服务器设计为在 stdio MCP客户端模式。它不是由最终用户直接运行的，而是集成到人工智能工具和应用程序中的。
运行服务器
演示模式（带水印）：
npx @documentfactory/mcp-server许可模式（无水印）：
LICENCEKEY="your-license-key" npx @documentfactory/mcp-server服务器将启动并通过标准输入/输出等待MCP客户端连接。
与AI工具集成
要将此服务器与AI工具一起使用：
- 带有MCP扩展的VS代码：将服务器配置添加到MCP设置中
- 克劳德桌面：将服务器添加到Claude配置中
- 其他MCP客户端：按照客户的文档添加MCP服务器
演示模式的示例配置（带水印）：
{
"mcpServers": {
"documentfactory": {
"command": "npx",
"args": ["@documentfactory/mcp-server"]
}
}
}许可模式的示例配置（无水印）：
{
"mcpServers": {
"documentfactory": {
"command": "npx",
"args": ["@documentfactory/mcp-server"],
"env": {
"LICENCEKEY": "your-license-key"
}
}
}
}特性
- 文档处理：通过DocumentFactory管道发送文档
- 演示和许可模式：尝试使用带有水印的PDF服务，或使用许可证进行干净输出
- NATS集成：与DocumentFactory的消息传递基础架构内置连接
- 交叉平台的：适用于Windows、macOS和Linux
- MCP兼容：适用于任何兼容MCP的AI工具或客户端
- 零安装：使用NPX立即运行-无需下载或设置
故障排除
常见问题
服务器无法启动：
- 确保您已安装Node.js以使NPX正常工作
- 检查您的互联网连接以下载二进制文件
- 如果使用许可模式，请验证许可证密钥格式
PDF上出现的水印：
- 这是演示模式下的正常行为
- 提供有效的
LICENCEKEY用于删除水印的环境变量
连接问题：
- 服务器自动连接到DocumentFactory的公共基础架构
- 确保防火墙允许出站连接
- 检查NPX是否可以从互联网下载软件包
NPX问题：
# Clear NPX cache if having download issues
npx clear-npx-cache获取帮助
如果您遇到问题：
- 首先尝试在演示模式下运行（不使用许可证密钥），以验证基本功能
- 检查NPX和Node.js是否已正确安装
- 验证您的互联网连接以下载软件包
- 如果使用许可模式，请确保您的许可证密钥有效
- 检查服务器日志中的错误消息
有关许可证密钥问题或技术支持，请联系DocumentFactory支持。
发展
从源头构建
如果你需要从源代码构建：
git clone https://github.com/GlobalCents-DocumentFactory/mcp-documentfactory.git
cd mcp-documentfactory
make build贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 运行测试：
make test-all - 提交拉取请求
系统要求
- 操作系统：Windows 10+、macOS 10.15+或Linux（任何现代发行版）
- Node.js：16+版本（NPX需要）
- 网络：用于包下载和DocumentFactory服务连接的Internet访问
- 记忆：最小（通常\<50MB RAM）
- 磁盘空间：最小（NPX自动处理缓存）
许可证
此项目根据LICENSE文件中指定的条款获得许可。
支持
有关技术支持和文档，请参阅项目的GitHub存储库或联系您的系统管理员。