Paperless-NGX MCP Server

基本能力

产品定位

Paperless-NGX MCP Server 是一个用于管理 Paperless-NGX 文档的 MCP 服务器，提供了一系列工具来帮助用户高效地管理和操作文档。

核心功能

1. 文档操作：包括列出文档、获取特定文档、搜索文档、下载文档、批量编辑文档和上传新文档。
2. 标签操作：列出所有标签和创建新标签。
3. 通信者操作：列出所有通信者和创建新通信者。
4. 文档类型操作：列出所有文档类型和创建新文档类型。

适用场景

1. 文档管理：用户可以通过该服务器高效地管理 Paperless-NGX 实例中的文档。
2. 批量操作：支持批量编辑文档，如批量添加标签、设置通信者等。
3. 文档搜索：提供全文搜索功能，方便用户快速找到需要的文档。
4. 文档上传：支持上传新文档到 Paperless-NGX 实例。

工具列表

1. list_documents：获取分页的文档列表。
2. get_document：通过 ID 获取特定文档。
3. search_documents：全文搜索文档。
4. download_document：通过 ID 下载文档。
5. bulk_edit_documents：批量编辑文档。
6. post_document：上传新文档。
7. list_tags：列出所有标签。
8. create_tag：创建新标签。
9. list_correspondents：列出所有通信者。
10. create_correspondent：创建新通信者。
11. list_document_types：列出所有文档类型。
12. create_document_type：创建新文档类型。

常见问题解答

1. 错误处理：服务器会显示清晰的错误消息，如 Paperless-NGX URL 或 API 令牌不正确、服务器不可达、操作失败或参数无效等。
2. 开发：如需修改服务器，可以克隆仓库、安装依赖并测试本地更改。

使用教程

使用依赖

1. 确保已安装 Node.js 和 npm。

安装教程

1. 通过 Smithery 安装：

npx -y @smithery/cli install @nloui/paperless-mcp --client claude

1. 手动安装：

npm install -g paperless-mcp

1. 添加到 Claude 的 MCP 配置：
2. 对于 VSCode 扩展，编辑 ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json。
3. 对于 Claude 桌面应用，编辑 ~/Library/Application Support/Claude/claude_desktop_config.json。
4. 获取 API 令牌：登录 Paperless-NGX 实例，生成新令牌。
5. 替换 MCP 配置中的占位符：
6. 替换 http://your-paperless-instance:8000 为 Paperless-NGX URL。
7. 替换 your-api-token 为生成的令牌。

调试方式

1. 测试本地更改：

node server.js http://localhost:8000 your-test-token

1. 查看错误消息：确保 Paperless-NGX URL 和 API 令牌正确，服务器可达。

许可证

None